diff --git a/README.md b/README.md index 92fe9ad84..597bd8df3 100755 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ override the new secure-http default setting)*. { "require": { "php": ">=8.0.0", - "cybersource/rest-client-php": "0.0.67" + "cybersource/rest-client-php": "0.0.68" } } ``` diff --git a/composer.json b/composer.json index e92a5be1f..f5f90e73d 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "cybersource/rest-client-php", - "version": "0.0.67", + "version": "0.0.68", "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" diff --git a/docs/Api/BankAccountValidationApi.md b/docs/Api/BankAccountValidationApi.md index 17ebfb85a..84cb12d90 100644 --- a/docs/Api/BankAccountValidationApi.md +++ b/docs/Api/BankAccountValidationApi.md @@ -8,7 +8,7 @@ Method | HTTP request | Description # **bankAccountValidationRequest** -> \CyberSource\Model\InlineResponse20013 bankAccountValidationRequest($accountValidationsRequest) +> \CyberSource\Model\InlineResponse20014 bankAccountValidationRequest($accountValidationsRequest) Visa Bank Account Validation Service @@ -39,7 +39,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse20013**](../Model/InlineResponse20013.md) +[**\CyberSource\Model\InlineResponse20014**](../Model/InlineResponse20014.md) ### Authorization diff --git a/docs/Api/BatchesApi.md b/docs/Api/BatchesApi.md index 522cd7725..25209e808 100644 --- a/docs/Api/BatchesApi.md +++ b/docs/Api/BatchesApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description # **getBatchReport** -> \CyberSource\Model\InlineResponse20012 getBatchReport($batchId) +> \CyberSource\Model\InlineResponse20013 getBatchReport($batchId) Retrieve a Batch Report @@ -42,7 +42,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse20012**](../Model/InlineResponse20012.md) +[**\CyberSource\Model\InlineResponse20013**](../Model/InlineResponse20013.md) ### Authorization @@ -56,7 +56,7 @@ 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) # **getBatchStatus** -> \CyberSource\Model\InlineResponse20011 getBatchStatus($batchId) +> \CyberSource\Model\InlineResponse20012 getBatchStatus($batchId) Retrieve a Batch Status @@ -87,7 +87,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse20011**](../Model/InlineResponse20011.md) +[**\CyberSource\Model\InlineResponse20012**](../Model/InlineResponse20012.md) ### Authorization @@ -101,7 +101,7 @@ 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) # **getBatchesList** -> \CyberSource\Model\InlineResponse20010 getBatchesList($offset, $limit, $fromDate, $toDate) +> \CyberSource\Model\InlineResponse20011 getBatchesList($offset, $limit, $fromDate, $toDate) List Batches @@ -138,7 +138,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse20010**](../Model/InlineResponse20010.md) +[**\CyberSource\Model\InlineResponse20011**](../Model/InlineResponse20011.md) ### Authorization diff --git a/docs/Api/CreateNewWebhooksApi.md b/docs/Api/CreateNewWebhooksApi.md index 308a772f4..2e5678ddb 100644 --- a/docs/Api/CreateNewWebhooksApi.md +++ b/docs/Api/CreateNewWebhooksApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **findProductsToSubscribe** -> \CyberSource\Model\InlineResponse2004[] findProductsToSubscribe($organizationId) +> \CyberSource\Model\InlineResponse2005[] findProductsToSubscribe($organizationId) Find Products You Can Subscribe To @@ -41,7 +41,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2004[]**](../Model/InlineResponse2004.md) +[**\CyberSource\Model\InlineResponse2005[]**](../Model/InlineResponse2005.md) ### Authorization diff --git a/docs/Api/DecisionManagerApi.md b/docs/Api/DecisionManagerApi.md index 2734363fe..6305ca87b 100644 --- a/docs/Api/DecisionManagerApi.md +++ b/docs/Api/DecisionManagerApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description # **actionDecisionManagerCase** -> \CyberSource\Model\InlineResponse2001 actionDecisionManagerCase($id, $caseManagementActionsRequest) +> \CyberSource\Model\InlineResponse2002 actionDecisionManagerCase($id, $caseManagementActionsRequest) Take action on a DM post-transactional case @@ -45,7 +45,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2001**](../Model/InlineResponse2001.md) +[**\CyberSource\Model\InlineResponse2002**](../Model/InlineResponse2002.md) ### Authorization diff --git a/docs/Api/DeviceDeAssociationApi.md b/docs/Api/DeviceDeAssociationApi.md index 9c803bdba..019be72f3 100644 --- a/docs/Api/DeviceDeAssociationApi.md +++ b/docs/Api/DeviceDeAssociationApi.md @@ -53,7 +53,7 @@ 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) # **postDeAssociateV3Terminal** -> \CyberSource\Model\InlineResponse2008[] postDeAssociateV3Terminal($deviceDeAssociateV3Request) +> \CyberSource\Model\InlineResponse2009[] postDeAssociateV3Terminal($deviceDeAssociateV3Request) De-associate a device from merchant to account or reseller and from account to reseller @@ -84,7 +84,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2008[]**](../Model/InlineResponse2008.md) +[**\CyberSource\Model\InlineResponse2009[]**](../Model/InlineResponse2009.md) ### Authorization diff --git a/docs/Api/DeviceSearchApi.md b/docs/Api/DeviceSearchApi.md index fee259f93..887797651 100644 --- a/docs/Api/DeviceSearchApi.md +++ b/docs/Api/DeviceSearchApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **postSearchQuery** -> \CyberSource\Model\InlineResponse2007 postSearchQuery($postDeviceSearchRequest) +> \CyberSource\Model\InlineResponse2008 postSearchQuery($postDeviceSearchRequest) Retrieve List of Devices for a given search query V2 @@ -40,7 +40,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2007**](../Model/InlineResponse2007.md) +[**\CyberSource\Model\InlineResponse2008**](../Model/InlineResponse2008.md) ### Authorization @@ -54,7 +54,7 @@ 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) # **postSearchQueryV3** -> \CyberSource\Model\InlineResponse2009 postSearchQueryV3($postDeviceSearchRequestV3) +> \CyberSource\Model\InlineResponse20010 postSearchQueryV3($postDeviceSearchRequestV3) Retrieve List of Devices for a given search query @@ -85,7 +85,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2009**](../Model/InlineResponse2009.md) +[**\CyberSource\Model\InlineResponse20010**](../Model/InlineResponse20010.md) ### Authorization diff --git a/docs/Api/ManageWebhooksApi.md b/docs/Api/ManageWebhooksApi.md index 8c369b3d4..86bddc9d0 100644 --- a/docs/Api/ManageWebhooksApi.md +++ b/docs/Api/ManageWebhooksApi.md @@ -103,7 +103,7 @@ 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) # **getWebhookSubscriptionsByOrg** -> \CyberSource\Model\InlineResponse2005[] getWebhookSubscriptionsByOrg($organizationId, $productId, $eventType) +> \CyberSource\Model\InlineResponse2006[] getWebhookSubscriptionsByOrg($organizationId, $productId, $eventType) Get Details On All Created Webhooks @@ -138,7 +138,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2005[]**](../Model/InlineResponse2005.md) +[**\CyberSource\Model\InlineResponse2006[]**](../Model/InlineResponse2006.md) ### Authorization @@ -197,7 +197,7 @@ 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) # **notificationSubscriptionsV2WebhooksWebhookIdPatch** -> \CyberSource\Model\InlineResponse2006 notificationSubscriptionsV2WebhooksWebhookIdPatch($webhookId, $updateWebhook) +> \CyberSource\Model\InlineResponse2007 notificationSubscriptionsV2WebhooksWebhookIdPatch($webhookId, $updateWebhook) Update a Webhook Subscription @@ -230,7 +230,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2006**](../Model/InlineResponse2006.md) +[**\CyberSource\Model\InlineResponse2007**](../Model/InlineResponse2007.md) ### Authorization diff --git a/docs/Api/MerchantBoardingApi.md b/docs/Api/MerchantBoardingApi.md index 25a37dee2..1259b9266 100644 --- a/docs/Api/MerchantBoardingApi.md +++ b/docs/Api/MerchantBoardingApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **getRegistration** -> \CyberSource\Model\InlineResponse2003 getRegistration($registrationId) +> \CyberSource\Model\InlineResponse2004 getRegistration($registrationId) Gets all the information on a boarding registration @@ -40,7 +40,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2003**](../Model/InlineResponse2003.md) +[**\CyberSource\Model\InlineResponse2004**](../Model/InlineResponse2004.md) ### Authorization diff --git a/docs/Api/MerchantDefinedFieldsApi.md b/docs/Api/MerchantDefinedFieldsApi.md index 4aae93323..10546218c 100644 --- a/docs/Api/MerchantDefinedFieldsApi.md +++ b/docs/Api/MerchantDefinedFieldsApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description # **createMerchantDefinedFieldDefinition** -> \CyberSource\Model\InlineResponse2002[] createMerchantDefinedFieldDefinition($referenceType, $merchantDefinedFieldDefinitionRequest) +> \CyberSource\Model\InlineResponse2003[] createMerchantDefinedFieldDefinition($referenceType, $merchantDefinedFieldDefinitionRequest) Create merchant defined field for a given reference type @@ -42,7 +42,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2002[]**](../Model/InlineResponse2002.md) +[**\CyberSource\Model\InlineResponse2003[]**](../Model/InlineResponse2003.md) ### Authorization @@ -100,7 +100,7 @@ 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) +> \CyberSource\Model\InlineResponse2003[] getMerchantDefinedFieldsDefinitions($referenceType) Get all merchant defined fields for a given reference type @@ -129,7 +129,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2002[]**](../Model/InlineResponse2002.md) +[**\CyberSource\Model\InlineResponse2003[]**](../Model/InlineResponse2003.md) ### Authorization @@ -143,7 +143,7 @@ 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) # **putMerchantDefinedFieldsDefinitions** -> \CyberSource\Model\InlineResponse2002[] putMerchantDefinedFieldsDefinitions($referenceType, $id, $merchantDefinedFieldCore) +> \CyberSource\Model\InlineResponse2003[] putMerchantDefinedFieldsDefinitions($referenceType, $id, $merchantDefinedFieldCore) Update a MerchantDefinedField by ID @@ -176,7 +176,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse2002[]**](../Model/InlineResponse2002.md) +[**\CyberSource\Model\InlineResponse2003[]**](../Model/InlineResponse2003.md) ### Authorization diff --git a/docs/Api/OffersApi.md b/docs/Api/OffersApi.md index 2129395f6..eeabb8ffc 100644 --- a/docs/Api/OffersApi.md +++ b/docs/Api/OffersApi.md @@ -64,7 +64,7 @@ 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) # **getOffer** -> \CyberSource\Model\InlineResponse20014 getOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $id) +> \CyberSource\Model\InlineResponse20015 getOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $id) Retrieve an Offer @@ -105,7 +105,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse20014**](../Model/InlineResponse20014.md) +[**\CyberSource\Model\InlineResponse20015**](../Model/InlineResponse20015.md) ### Authorization diff --git a/docs/Api/SubscriptionsApi.md b/docs/Api/SubscriptionsApi.md index 47f6b113d..a8af63bab 100644 --- a/docs/Api/SubscriptionsApi.md +++ b/docs/Api/SubscriptionsApi.md @@ -4,7 +4,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**activateSubscription**](SubscriptionsApi.md#activateSubscription) | **POST** /rbs/v1/subscriptions/{id}/activate | Activate a Subscription +[**activateSubscription**](SubscriptionsApi.md#activateSubscription) | **POST** /rbs/v1/subscriptions/{id}/activate | Reactivating a Suspended Subscription [**cancelSubscription**](SubscriptionsApi.md#cancelSubscription) | **POST** /rbs/v1/subscriptions/{id}/cancel | Cancel a Subscription [**createSubscription**](SubscriptionsApi.md#createSubscription) | **POST** /rbs/v1/subscriptions | Create a Subscription [**getAllSubscriptions**](SubscriptionsApi.md#getAllSubscriptions) | **GET** /rbs/v1/subscriptions | Get a List of Subscriptions @@ -15,11 +15,11 @@ Method | HTTP request | Description # **activateSubscription** -> \CyberSource\Model\ActivateSubscriptionResponse activateSubscription($id, $processSkippedPayments) +> \CyberSource\Model\ActivateSubscriptionResponse activateSubscription($id, $processMissedPayments) -Activate a Subscription +Reactivating a Suspended Subscription -Activate a `SUSPENDED` Subscription +# Reactivating a Suspended Subscription You can reactivate a suspended subscription for the next billing cycle. You cannot reactivate a canceled or completed subscription. You can specify whether you want to process missed payments for the period during which the subscription was suspended using the `processMissedPayments` query parameter by setting it to true or false. If no value is specified, the system will default to `true`. **Important:** The \"processMissedPayments\" query parameter is only effective when the Ask each time before reactivating option is selected in the reactivation settings. If any other option is chosen, the value provided in the request will be ignored by the system. For more information, see the [Recurring Billing User Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/user/all/rest/recurring-billing-user/recurring-billing-user-about-guide.html). You can check how many payments were missed and the total amount by retrieving the subscription details, where you will find the `reactivationInformation` object. See: [Retrieving a Subscription](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-dev/recur-bill-subscriptions/recur-bill-getting-a-subscription.html). ### Example ```php @@ -28,10 +28,10 @@ require_once(__DIR__ . '/vendor/autoload.php'); $api_instance = new CyberSource\Api\SubscriptionsApi(); $id = "id_example"; // string | Subscription Id -$processSkippedPayments = true; // bool | Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. +$processMissedPayments = true; // bool | Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true. When any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored. try { - $result = $api_instance->activateSubscription($id, $processSkippedPayments); + $result = $api_instance->activateSubscription($id, $processMissedPayments); print_r($result); } catch (Exception $e) { echo 'Exception when calling SubscriptionsApi->activateSubscription: ', $e->getMessage(), PHP_EOL; @@ -44,7 +44,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Subscription Id | - **processSkippedPayments** | **bool**| Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. | [optional] [default to true] + **processMissedPayments** | **bool**| Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true. When any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored. | [optional] [default to true] ### Return type diff --git a/docs/Api/TokenApi.md b/docs/Api/TokenApi.md index cb2179cf8..29f1092fa 100644 --- a/docs/Api/TokenApi.md +++ b/docs/Api/TokenApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **getCardArtAsset** -> \CyberSource\Model\InlineResponse200 getCardArtAsset($instrumentIdentifierId, $tokenProvider, $assetType) +> \CyberSource\Model\InlineResponse2001 getCardArtAsset($instrumentIdentifierId, $tokenProvider, $assetType) Retrieve Card Art @@ -44,7 +44,7 @@ Name | Type | Description | Notes ### Return type -[**\CyberSource\Model\InlineResponse200**](../Model/InlineResponse200.md) +[**\CyberSource\Model\InlineResponse2001**](../Model/InlineResponse2001.md) ### Authorization diff --git a/docs/Api/TokenizeApi.md b/docs/Api/TokenizeApi.md new file mode 100644 index 000000000..98f7a9d78 --- /dev/null +++ b/docs/Api/TokenizeApi.md @@ -0,0 +1,56 @@ +# CyberSource\TokenizeApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**tokenize**](TokenizeApi.md#tokenize) | **POST** /tms/v2/tokenize | Tokenize + + +# **tokenize** +> \CyberSource\Model\InlineResponse200 tokenize($postTokenizeRequest, $profileId) + +Tokenize + +| | | | | --- | --- | --- | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **\"TOKEN_CREATE\"** and the types of tokens to be created. The **tokenInformation** section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|      |The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.
In cases where token creation encounters issues, the response includes a **non-2XX** status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed. + +### Example +```php +tokenize($postTokenizeRequest, $profileId); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling TokenizeApi->tokenize: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **postTokenizeRequest** | [**\CyberSource\Model\PostTokenizeRequest**](../Model/PostTokenizeRequest.md)| | + **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional] + +### Return type + +[**\CyberSource\Model\InlineResponse200**](../Model/InlineResponse200.md) + +### 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) + diff --git a/docs/Api/TokenizedCardApi.md b/docs/Api/TokenizedCardApi.md index 25440d3f5..7d40b3a4a 100644 --- a/docs/Api/TokenizedCardApi.md +++ b/docs/Api/TokenizedCardApi.md @@ -6,6 +6,7 @@ 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 @@ -102,6 +103,54 @@ 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**
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 +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) diff --git a/docs/Model/CreatePlanRequest.md b/docs/Model/CreatePlanRequest.md index a12a1b129..69abd4b67 100644 --- a/docs/Model/CreatePlanRequest.md +++ b/docs/Model/CreatePlanRequest.md @@ -3,7 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**\CyberSource\Model\Rbsv1plansClientReferenceInformation**](Rbsv1plansClientReferenceInformation.md) | | [optional] **planInformation** | [**\CyberSource\Model\Rbsv1plansPlanInformation**](Rbsv1plansPlanInformation.md) | | [optional] **orderInformation** | [**\CyberSource\Model\Rbsv1plansOrderInformation**](Rbsv1plansOrderInformation.md) | | [optional] diff --git a/docs/Model/CreateSubscriptionRequest.md b/docs/Model/CreateSubscriptionRequest.md index 11ad944c4..d1f62ed14 100644 --- a/docs/Model/CreateSubscriptionRequest.md +++ b/docs/Model/CreateSubscriptionRequest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation**](GetAllSubscriptionsResponseClientReferenceInformation.md) | | [optional] **processingInformation** | [**\CyberSource\Model\Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional] **planInformation** | [**\CyberSource\Model\Rbsv1subscriptionsPlanInformation**](Rbsv1subscriptionsPlanInformation.md) | | [optional] **subscriptionInformation** | [**\CyberSource\Model\Rbsv1subscriptionsSubscriptionInformation**](Rbsv1subscriptionsSubscriptionInformation.md) | | [optional] diff --git a/docs/Model/CreateSubscriptionRequest1.md b/docs/Model/CreateSubscriptionRequest1.md index 861e3cbfb..446a38459 100644 --- a/docs/Model/CreateSubscriptionRequest1.md +++ b/docs/Model/CreateSubscriptionRequest1.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation**](GetAllSubscriptionsResponseClientReferenceInformation.md) | | [optional] **processingInformation** | [**\CyberSource\Model\Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional] **planInformation** | [**\CyberSource\Model\Rbsv1subscriptionsPlanInformation**](Rbsv1subscriptionsPlanInformation.md) | | [optional] **subscriptionInformation** | [**\CyberSource\Model\Rbsv1subscriptionsSubscriptionInformation**](Rbsv1subscriptionsSubscriptionInformation.md) | | [optional] diff --git a/docs/Model/CreateSubscriptionResponse.md b/docs/Model/CreateSubscriptionResponse.md index 032005f54..c4e8ccae8 100644 --- a/docs/Model/CreateSubscriptionResponse.md +++ b/docs/Model/CreateSubscriptionResponse.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] **status** | **string** | The status of the submitted transaction. Possible values: - COMPLETED - PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional] **subscriptionInformation** | [**\CyberSource\Model\CreateSubscriptionResponseSubscriptionInformation**](CreateSubscriptionResponseSubscriptionInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation**](GetAllSubscriptionsResponseClientReferenceInformation.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) diff --git a/docs/Model/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/Model/GenerateUnifiedCheckoutCaptureContextRequest.md index ec07520a8..3cbbbc9b4 100644 --- a/docs/Model/GenerateUnifiedCheckoutCaptureContextRequest.md +++ b/docs/Model/GenerateUnifiedCheckoutCaptureContextRequest.md @@ -6,9 +6,10 @@ Name | Type | Description | Notes **clientVersion** | **string** | Specify the version of Unified Checkout that you want to use. | [optional] **targetOrigins** | **string[]** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] | [optional] **allowedCardNetworks** | **string[]** | The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP | [optional] -**allowedPaymentTypes** | **string[]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY<br><br> Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB) Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional] +**allowedPaymentTypes** | **string[]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY<br><br> Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB)<br><br> Unified Checkout supports the following Post-Pay Reference payment methods: - Konbini (JP)<br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional] **country** | **string** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional] **locale** | **string** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) | [optional] +**buttonType** | **string** | Changes the label on the payment button within Unified Checkout .<br><br> Possible values: - ADD_CARD - CARD_PAYMENT - CHECKOUT - CHECKOUT_AND_CONTINUE - DEBIT_CREDIT - DONATE - PAY - PAY_WITH_CARD - SAVE_CARD - SUBSCRIBE_WITH_CARD<br><br> This is an optional field, | [optional] **captureMandate** | [**\CyberSource\Model\Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional] **completeMandate** | [**\CyberSource\Model\Upv1capturecontextsCompleteMandate**](Upv1capturecontextsCompleteMandate.md) | | [optional] **transientTokenResponseOptions** | [**\CyberSource\Model\Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional] diff --git a/docs/Model/GetAllSubscriptionsResponseClientReferenceInformation.md b/docs/Model/GetAllSubscriptionsResponseClientReferenceInformation.md new file mode 100644 index 000000000..ad90f5b70 --- /dev/null +++ b/docs/Model/GetAllSubscriptionsResponseClientReferenceInformation.md @@ -0,0 +1,10 @@ +# GetAllSubscriptionsResponseClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **string** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [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) + + diff --git a/docs/Model/GetAllSubscriptionsResponseSubscriptions.md b/docs/Model/GetAllSubscriptionsResponseSubscriptions.md index 2f8c56c23..00814f757 100644 --- a/docs/Model/GetAllSubscriptionsResponseSubscriptions.md +++ b/docs/Model/GetAllSubscriptionsResponseSubscriptions.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **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] **planInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponsePlanInformation**](GetAllSubscriptionsResponsePlanInformation.md) | | [optional] **subscriptionInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseSubscriptionInformation**](GetAllSubscriptionsResponseSubscriptionInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation**](GetAllSubscriptionsResponseClientReferenceInformation.md) | | [optional] **paymentInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponsePaymentInformation**](GetAllSubscriptionsResponsePaymentInformation.md) | | [optional] **orderInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseOrderInformation**](GetAllSubscriptionsResponseOrderInformation.md) | | [optional] diff --git a/docs/Model/GetSubscriptionResponse.md b/docs/Model/GetSubscriptionResponse.md index 12ab014fa..fe2ffb8ba 100644 --- a/docs/Model/GetSubscriptionResponse.md +++ b/docs/Model/GetSubscriptionResponse.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **subscriptionInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseSubscriptionInformation**](GetAllSubscriptionsResponseSubscriptionInformation.md) | | [optional] **paymentInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponsePaymentInformation**](GetAllSubscriptionsResponsePaymentInformation.md) | | [optional] **orderInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseOrderInformation**](GetAllSubscriptionsResponseOrderInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation**](GetAllSubscriptionsResponseClientReferenceInformation.md) | | [optional] **reactivationInformation** | [**\CyberSource\Model\GetSubscriptionResponseReactivationInformation**](GetSubscriptionResponseReactivationInformation.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) diff --git a/docs/Model/GetSubscriptionResponse1PaymentInstrument.md b/docs/Model/GetSubscriptionResponse1PaymentInstrument.md index ed2dfde97..0bfd45a78 100644 --- a/docs/Model/GetSubscriptionResponse1PaymentInstrument.md +++ b/docs/Model/GetSubscriptionResponse1PaymentInstrument.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **id** | **string** | The Id of the Payment Instrument Token. | [optional] **bankAccount** | [**\CyberSource\Model\GetSubscriptionResponse1PaymentInstrumentBankAccount**](GetSubscriptionResponse1PaymentInstrumentBankAccount.md) | | [optional] **card** | [**\CyberSource\Model\GetSubscriptionResponse1PaymentInstrumentCard**](GetSubscriptionResponse1PaymentInstrumentCard.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] **buyerInformation** | [**\CyberSource\Model\GetSubscriptionResponse1PaymentInstrumentBuyerInformation**](GetSubscriptionResponse1PaymentInstrumentBuyerInformation.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) diff --git a/docs/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.md b/docs/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.md index fb566fa42..180a4922b 100644 --- a/docs/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.md +++ b/docs/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **companyTaxID** | **string** | Company's tax identifier. This is only used for eCheck service. | [optional] **currency** | **string** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [optional] **dateOfBirth** | [**\DateTime**](\DateTime.md) | Date of birth of the customer. Format: YYYY-MM-DD | [optional] -**personalIdentification** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md) | | [optional] +**personalIdentification** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.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) diff --git a/docs/Model/GetSubscriptionResponse1ShippingAddress.md b/docs/Model/GetSubscriptionResponse1ShippingAddress.md index b59bc92b8..36baac0b7 100644 --- a/docs/Model/GetSubscriptionResponse1ShippingAddress.md +++ b/docs/Model/GetSubscriptionResponse1ShippingAddress.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | The Id of the Shipping Address Token. | [optional] -**shipTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) | | [optional] +**shipTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.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) diff --git a/docs/Model/GetSubscriptionResponseReactivationInformation.md b/docs/Model/GetSubscriptionResponseReactivationInformation.md index ca9ecd55c..59de3547d 100644 --- a/docs/Model/GetSubscriptionResponseReactivationInformation.md +++ b/docs/Model/GetSubscriptionResponseReactivationInformation.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**skippedPaymentsCount** | **string** | Number of payments that should have occurred while the subscription was in a suspended status. | [optional] -**skippedPaymentsTotalAmount** | **string** | Total amount that will be charged upon reactivation if `processSkippedPayments` is set to `true`. | [optional] +**missedPaymentsCount** | **string** | Number of payments that should have occurred while the subscription was in a suspended status. | [optional] +**missedPaymentsTotalAmount** | **string** | Total amount that will be charged upon reactivation if `processMissedPayments` is set to `true`. | [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) diff --git a/docs/Model/InlineResponse200.md b/docs/Model/InlineResponse200.md index ee440ff95..f3d9ef023 100644 --- a/docs/Model/InlineResponse200.md +++ b/docs/Model/InlineResponse200.md @@ -3,10 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **string** | Unique identifier for the Card Art Asset. | [optional] -**type** | **string** | The type of Card Art Asset. | [optional] -**provider** | **string** | The provider of the Card Art Asset. | [optional] -**content** | [**\CyberSource\Model\InlineResponse200Content[]**](InlineResponse200Content.md) | Array of content objects representing the Card Art Asset. | [optional] +**responses** | [**\CyberSource\Model\InlineResponse200Responses[]**](InlineResponse200Responses.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) diff --git a/docs/Model/InlineResponse2001.md b/docs/Model/InlineResponse2001.md index f5f24d4b3..5c1985072 100644 --- a/docs/Model/InlineResponse2001.md +++ b/docs/Model/InlineResponse2001.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **string** | UUID uniquely generated for this comments. | [optional] -**submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] -**status** | **string** | The status of the submitted transaction. Possible values are: - `ACCEPTED` - `REJECTED` | [optional] -**embedded** | [**\CyberSource\Model\InlineResponse2001Embedded**](InlineResponse2001Embedded.md) | | [optional] +**id** | **string** | Unique identifier for the Card Art Asset. | [optional] +**type** | **string** | The type of Card Art Asset. | [optional] +**provider** | **string** | The provider of the Card Art Asset. | [optional] +**content** | [**\CyberSource\Model\InlineResponse2001Content[]**](InlineResponse2001Content.md) | Array of content objects representing the Card Art Asset. | [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) diff --git a/docs/Model/InlineResponse20010.md b/docs/Model/InlineResponse20010.md index 8543aa178..dab466491 100644 --- a/docs/Model/InlineResponse20010.md +++ b/docs/Model/InlineResponse20010.md @@ -3,13 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\InlineResponse20010Links[]**](InlineResponse20010Links.md) | | [optional] -**object** | **string** | | [optional] -**offset** | **int** | | [optional] -**limit** | **int** | | [optional] -**count** | **int** | | [optional] -**total** | **int** | | [optional] -**embedded** | [**\CyberSource\Model\InlineResponse20010Embedded**](InlineResponse20010Embedded.md) | | [optional] +**totalCount** | **int** | Total number of results. | [optional] +**offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] +**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] +**sort** | **string** | A comma separated list of the following form: `terminalCreationDate:desc or serialNumber or terminalUpdationDate` | [optional] +**count** | **int** | Results for this page, this could be below the limit. | [optional] +**devices** | [**\CyberSource\Model\InlineResponse20010Devices[]**](InlineResponse20010Devices.md) | A collection of devices | [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) diff --git a/docs/Model/InlineResponse2009Devices.md b/docs/Model/InlineResponse20010Devices.md similarity index 89% rename from docs/Model/InlineResponse2009Devices.md rename to docs/Model/InlineResponse20010Devices.md index 50b91e6d9..2cc859ae7 100644 --- a/docs/Model/InlineResponse2009Devices.md +++ b/docs/Model/InlineResponse20010Devices.md @@ -1,4 +1,4 @@ -# InlineResponse2009Devices +# InlineResponse20010Devices ## Properties Name | Type | Description | Notes @@ -14,7 +14,7 @@ Name | Type | Description | Notes **accountId** | **string** | ID of the account to whom the device assigned. | [optional] **terminalCreationDate** | [**\DateTime**](\DateTime.md) | Timestamp in which the device was created. | [optional] **terminalUpdationDate** | [**\DateTime**](\DateTime.md) | Timestamp in which the device was updated/modified. | [optional] -**paymentProcessorToTerminalMap** | [**\CyberSource\Model\InlineResponse2009PaymentProcessorToTerminalMap**](InlineResponse2009PaymentProcessorToTerminalMap.md) | | [optional] +**paymentProcessorToTerminalMap** | [**\CyberSource\Model\InlineResponse20010PaymentProcessorToTerminalMap**](InlineResponse20010PaymentProcessorToTerminalMap.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) diff --git a/docs/Model/InlineResponse2009PaymentProcessorToTerminalMap.md b/docs/Model/InlineResponse20010PaymentProcessorToTerminalMap.md similarity index 87% rename from docs/Model/InlineResponse2009PaymentProcessorToTerminalMap.md rename to docs/Model/InlineResponse20010PaymentProcessorToTerminalMap.md index 293973ce5..9adeb9fcc 100644 --- a/docs/Model/InlineResponse2009PaymentProcessorToTerminalMap.md +++ b/docs/Model/InlineResponse20010PaymentProcessorToTerminalMap.md @@ -1,4 +1,4 @@ -# InlineResponse2009PaymentProcessorToTerminalMap +# InlineResponse20010PaymentProcessorToTerminalMap ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20011.md b/docs/Model/InlineResponse20011.md index c9a1897f2..45b05da08 100644 --- a/docs/Model/InlineResponse20011.md +++ b/docs/Model/InlineResponse20011.md @@ -3,16 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\InlineResponse20011Links**](InlineResponse20011Links.md) | | [optional] -**batchId** | **string** | Unique identification number assigned to the submitted request. | [optional] -**batchCreatedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] -**batchSource** | **string** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] -**merchantReference** | **string** | Reference used by merchant to identify batch. | [optional] -**batchCaEndpoints** | **string** | | [optional] -**status** | **string** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED | [optional] -**totals** | [**\CyberSource\Model\InlineResponse20010EmbeddedTotals**](InlineResponse20010EmbeddedTotals.md) | | [optional] -**billing** | [**\CyberSource\Model\InlineResponse20011Billing**](InlineResponse20011Billing.md) | | [optional] -**description** | **string** | | [optional] +**links** | [**\CyberSource\Model\InlineResponse20011Links[]**](InlineResponse20011Links.md) | | [optional] +**object** | **string** | | [optional] +**offset** | **int** | | [optional] +**limit** | **int** | | [optional] +**count** | **int** | | [optional] +**total** | **int** | | [optional] +**embedded** | [**\CyberSource\Model\InlineResponse20011Embedded**](InlineResponse20011Embedded.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) diff --git a/docs/Model/InlineResponse20010Embedded.md b/docs/Model/InlineResponse20011Embedded.md similarity index 63% rename from docs/Model/InlineResponse20010Embedded.md rename to docs/Model/InlineResponse20011Embedded.md index d32e99faf..f31cad589 100644 --- a/docs/Model/InlineResponse20010Embedded.md +++ b/docs/Model/InlineResponse20011Embedded.md @@ -1,9 +1,9 @@ -# InlineResponse20010Embedded +# InlineResponse20011Embedded ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**batches** | [**\CyberSource\Model\InlineResponse20010EmbeddedBatches[]**](InlineResponse20010EmbeddedBatches.md) | | [optional] +**batches** | [**\CyberSource\Model\InlineResponse20011EmbeddedBatches[]**](InlineResponse20011EmbeddedBatches.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) diff --git a/docs/Model/InlineResponse20010EmbeddedBatches.md b/docs/Model/InlineResponse20011EmbeddedBatches.md similarity index 80% rename from docs/Model/InlineResponse20010EmbeddedBatches.md rename to docs/Model/InlineResponse20011EmbeddedBatches.md index b479cf618..28699958f 100644 --- a/docs/Model/InlineResponse20010EmbeddedBatches.md +++ b/docs/Model/InlineResponse20011EmbeddedBatches.md @@ -1,9 +1,9 @@ -# InlineResponse20010EmbeddedBatches +# InlineResponse20011EmbeddedBatches ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\InlineResponse20010EmbeddedLinks**](InlineResponse20010EmbeddedLinks.md) | | [optional] +**links** | [**\CyberSource\Model\InlineResponse20011EmbeddedLinks**](InlineResponse20011EmbeddedLinks.md) | | [optional] **batchId** | **string** | Unique identification number assigned to the submitted request. | [optional] **batchCreatedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] **batchModifiedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] @@ -12,7 +12,7 @@ Name | Type | Description | Notes **merchantReference** | **string** | Reference used by merchant to identify batch. | [optional] **batchCaEndpoints** | **string[]** | Valid Values: * VISA * MASTERCARD * AMEX | [optional] **status** | **string** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETE | [optional] -**totals** | [**\CyberSource\Model\InlineResponse20010EmbeddedTotals**](InlineResponse20010EmbeddedTotals.md) | | [optional] +**totals** | [**\CyberSource\Model\InlineResponse20011EmbeddedTotals**](InlineResponse20011EmbeddedTotals.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) diff --git a/docs/Model/InlineResponse20010EmbeddedLinks.md b/docs/Model/InlineResponse20011EmbeddedLinks.md similarity index 63% rename from docs/Model/InlineResponse20010EmbeddedLinks.md rename to docs/Model/InlineResponse20011EmbeddedLinks.md index 3c02e9261..9af498acb 100644 --- a/docs/Model/InlineResponse20010EmbeddedLinks.md +++ b/docs/Model/InlineResponse20011EmbeddedLinks.md @@ -1,9 +1,9 @@ -# InlineResponse20010EmbeddedLinks +# InlineResponse20011EmbeddedLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reports** | [**\CyberSource\Model\InlineResponse20010EmbeddedLinksReports[]**](InlineResponse20010EmbeddedLinksReports.md) | | [optional] +**reports** | [**\CyberSource\Model\InlineResponse20011EmbeddedLinksReports[]**](InlineResponse20011EmbeddedLinksReports.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) diff --git a/docs/Model/InlineResponse20010EmbeddedLinksReports.md b/docs/Model/InlineResponse20011EmbeddedLinksReports.md similarity index 88% rename from docs/Model/InlineResponse20010EmbeddedLinksReports.md rename to docs/Model/InlineResponse20011EmbeddedLinksReports.md index 26901739c..0acec8ec5 100644 --- a/docs/Model/InlineResponse20010EmbeddedLinksReports.md +++ b/docs/Model/InlineResponse20011EmbeddedLinksReports.md @@ -1,4 +1,4 @@ -# InlineResponse20010EmbeddedLinksReports +# InlineResponse20011EmbeddedLinksReports ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20010EmbeddedTotals.md b/docs/Model/InlineResponse20011EmbeddedTotals.md similarity index 93% rename from docs/Model/InlineResponse20010EmbeddedTotals.md rename to docs/Model/InlineResponse20011EmbeddedTotals.md index fb5f36298..c84ffbadd 100644 --- a/docs/Model/InlineResponse20010EmbeddedTotals.md +++ b/docs/Model/InlineResponse20011EmbeddedTotals.md @@ -1,4 +1,4 @@ -# InlineResponse20010EmbeddedTotals +# InlineResponse20011EmbeddedTotals ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20011Links.md b/docs/Model/InlineResponse20011Links.md index 7eb192e5d..2d728ee69 100644 --- a/docs/Model/InlineResponse20011Links.md +++ b/docs/Model/InlineResponse20011Links.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**self** | [**\CyberSource\Model\InlineResponse202LinksStatus**](InlineResponse202LinksStatus.md) | | [optional] -**report** | [**\CyberSource\Model\InlineResponse20011LinksReport[]**](InlineResponse20011LinksReport.md) | | [optional] +**rel** | **string** | Valid Values: * self * first * last * prev * next | [optional] +**href** | **string** | | [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) diff --git a/docs/Model/InlineResponse20012.md b/docs/Model/InlineResponse20012.md index 22e94b4d8..891c1eef4 100644 --- a/docs/Model/InlineResponse20012.md +++ b/docs/Model/InlineResponse20012.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**version** | **string** | | [optional] -**reportCreatedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**links** | [**\CyberSource\Model\InlineResponse20012Links**](InlineResponse20012Links.md) | | [optional] **batchId** | **string** | Unique identification number assigned to the submitted request. | [optional] -**batchSource** | **string** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] -**batchCaEndpoints** | **string** | | [optional] **batchCreatedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**batchSource** | **string** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] **merchantReference** | **string** | Reference used by merchant to identify batch. | [optional] -**totals** | [**\CyberSource\Model\InlineResponse20010EmbeddedTotals**](InlineResponse20010EmbeddedTotals.md) | | [optional] -**billing** | [**\CyberSource\Model\InlineResponse20011Billing**](InlineResponse20011Billing.md) | | [optional] -**records** | [**\CyberSource\Model\InlineResponse20012Records[]**](InlineResponse20012Records.md) | | [optional] +**batchCaEndpoints** | **string** | | [optional] +**status** | **string** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED | [optional] +**totals** | [**\CyberSource\Model\InlineResponse20011EmbeddedTotals**](InlineResponse20011EmbeddedTotals.md) | | [optional] +**billing** | [**\CyberSource\Model\InlineResponse20012Billing**](InlineResponse20012Billing.md) | | [optional] +**description** | **string** | | [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) diff --git a/docs/Model/InlineResponse20011Billing.md b/docs/Model/InlineResponse20012Billing.md similarity index 93% rename from docs/Model/InlineResponse20011Billing.md rename to docs/Model/InlineResponse20012Billing.md index 0fd0671a2..144e0bcfa 100644 --- a/docs/Model/InlineResponse20011Billing.md +++ b/docs/Model/InlineResponse20012Billing.md @@ -1,4 +1,4 @@ -# InlineResponse20011Billing +# InlineResponse20012Billing ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20012Links.md b/docs/Model/InlineResponse20012Links.md new file mode 100644 index 000000000..cfe100b1c --- /dev/null +++ b/docs/Model/InlineResponse20012Links.md @@ -0,0 +1,11 @@ +# InlineResponse20012Links + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**self** | [**\CyberSource\Model\InlineResponse202LinksStatus**](InlineResponse202LinksStatus.md) | | [optional] +**report** | [**\CyberSource\Model\InlineResponse20012LinksReport[]**](InlineResponse20012LinksReport.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) + + diff --git a/docs/Model/InlineResponse20011LinksReport.md b/docs/Model/InlineResponse20012LinksReport.md similarity index 90% rename from docs/Model/InlineResponse20011LinksReport.md rename to docs/Model/InlineResponse20012LinksReport.md index feeed96dd..b68d167e8 100644 --- a/docs/Model/InlineResponse20011LinksReport.md +++ b/docs/Model/InlineResponse20012LinksReport.md @@ -1,4 +1,4 @@ -# InlineResponse20011LinksReport +# InlineResponse20012LinksReport ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20013.md b/docs/Model/InlineResponse20013.md index 5936e1626..8bc0723bc 100644 --- a/docs/Model/InlineResponse20013.md +++ b/docs/Model/InlineResponse20013.md @@ -3,10 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**\CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation**](Bavsv1accountvalidationsClientReferenceInformation.md) | | [optional] -**requestId** | **string** | Request Id sent as part of the request. | [optional] -**submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThhmmssZ`, where: - `T`: Separates the date and the time - `Z`: Indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT) Example: `2020-01-11T224757Z` equals January 11, 2020, at 22:47:57 (10:47:57 p.m.) | [optional] -**bankAccountValidation** | [**\CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation**](TssV2TransactionsGet200ResponseBankAccountValidation.md) | | [optional] +**version** | **string** | | [optional] +**reportCreatedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**batchId** | **string** | Unique identification number assigned to the submitted request. | [optional] +**batchSource** | **string** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] +**batchCaEndpoints** | **string** | | [optional] +**batchCreatedDate** | **string** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**merchantReference** | **string** | Reference used by merchant to identify batch. | [optional] +**totals** | [**\CyberSource\Model\InlineResponse20011EmbeddedTotals**](InlineResponse20011EmbeddedTotals.md) | | [optional] +**billing** | [**\CyberSource\Model\InlineResponse20012Billing**](InlineResponse20012Billing.md) | | [optional] +**records** | [**\CyberSource\Model\InlineResponse20013Records[]**](InlineResponse20013Records.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) diff --git a/docs/Model/InlineResponse20012Records.md b/docs/Model/InlineResponse20013Records.md similarity index 52% rename from docs/Model/InlineResponse20012Records.md rename to docs/Model/InlineResponse20013Records.md index 7cbde2876..57c08321d 100644 --- a/docs/Model/InlineResponse20012Records.md +++ b/docs/Model/InlineResponse20013Records.md @@ -1,11 +1,11 @@ -# InlineResponse20012Records +# InlineResponse20013Records ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | | [optional] -**sourceRecord** | [**\CyberSource\Model\InlineResponse20012SourceRecord**](InlineResponse20012SourceRecord.md) | | [optional] -**responseRecord** | [**\CyberSource\Model\InlineResponse20012ResponseRecord**](InlineResponse20012ResponseRecord.md) | | [optional] +**sourceRecord** | [**\CyberSource\Model\InlineResponse20013SourceRecord**](InlineResponse20013SourceRecord.md) | | [optional] +**responseRecord** | [**\CyberSource\Model\InlineResponse20013ResponseRecord**](InlineResponse20013ResponseRecord.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) diff --git a/docs/Model/InlineResponse20012ResponseRecord.md b/docs/Model/InlineResponse20013ResponseRecord.md similarity index 90% rename from docs/Model/InlineResponse20012ResponseRecord.md rename to docs/Model/InlineResponse20013ResponseRecord.md index c1ca41fd6..8ae794b71 100644 --- a/docs/Model/InlineResponse20012ResponseRecord.md +++ b/docs/Model/InlineResponse20013ResponseRecord.md @@ -1,4 +1,4 @@ -# InlineResponse20012ResponseRecord +# InlineResponse20013ResponseRecord ## Properties Name | Type | Description | Notes @@ -12,7 +12,7 @@ Name | Type | Description | Notes **cardExpiryMonth** | **string** | | [optional] **cardExpiryYear** | **string** | | [optional] **cardType** | **string** | | [optional] -**additionalUpdates** | [**\CyberSource\Model\InlineResponse20012ResponseRecordAdditionalUpdates[]**](InlineResponse20012ResponseRecordAdditionalUpdates.md) | | [optional] +**additionalUpdates** | [**\CyberSource\Model\InlineResponse20013ResponseRecordAdditionalUpdates[]**](InlineResponse20013ResponseRecordAdditionalUpdates.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) diff --git a/docs/Model/InlineResponse20012ResponseRecordAdditionalUpdates.md b/docs/Model/InlineResponse20013ResponseRecordAdditionalUpdates.md similarity index 90% rename from docs/Model/InlineResponse20012ResponseRecordAdditionalUpdates.md rename to docs/Model/InlineResponse20013ResponseRecordAdditionalUpdates.md index 7a18042da..b341e4c9f 100644 --- a/docs/Model/InlineResponse20012ResponseRecordAdditionalUpdates.md +++ b/docs/Model/InlineResponse20013ResponseRecordAdditionalUpdates.md @@ -1,4 +1,4 @@ -# InlineResponse20012ResponseRecordAdditionalUpdates +# InlineResponse20013ResponseRecordAdditionalUpdates ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20012SourceRecord.md b/docs/Model/InlineResponse20013SourceRecord.md similarity index 95% rename from docs/Model/InlineResponse20012SourceRecord.md rename to docs/Model/InlineResponse20013SourceRecord.md index dd7bf34ac..1b36ea364 100644 --- a/docs/Model/InlineResponse20012SourceRecord.md +++ b/docs/Model/InlineResponse20013SourceRecord.md @@ -1,4 +1,4 @@ -# InlineResponse20012SourceRecord +# InlineResponse20013SourceRecord ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse20014.md b/docs/Model/InlineResponse20014.md index 7e6562a1c..22c8b1809 100644 --- a/docs/Model/InlineResponse20014.md +++ b/docs/Model/InlineResponse20014.md @@ -3,12 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**\CyberSource\Model\InlineResponse20014ClientReferenceInformation**](InlineResponse20014ClientReferenceInformation.md) | | [optional] -**id** | **string** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid | -**submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | -**status** | **string** | Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` | -**errorInformation** | [**\CyberSource\Model\InlineResponse2018ErrorInformation**](InlineResponse2018ErrorInformation.md) | | [optional] -**orderInformation** | [**\CyberSource\Model\InlineResponse2018OrderInformation**](InlineResponse2018OrderInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation**](Bavsv1accountvalidationsClientReferenceInformation.md) | | [optional] +**requestId** | **string** | Request Id sent as part of the request. | [optional] +**submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThhmmssZ`, where: - `T`: Separates the date and the time - `Z`: Indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT) Example: `2020-01-11T224757Z` equals January 11, 2020, at 22:47:57 (10:47:57 p.m.) | [optional] +**bankAccountValidation** | [**\CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation**](TssV2TransactionsGet200ResponseBankAccountValidation.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) diff --git a/docs/Model/InlineResponse20015.md b/docs/Model/InlineResponse20015.md new file mode 100644 index 000000000..49e9c6c87 --- /dev/null +++ b/docs/Model/InlineResponse20015.md @@ -0,0 +1,15 @@ +# InlineResponse20015 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**\CyberSource\Model\InlineResponse20015ClientReferenceInformation**](InlineResponse20015ClientReferenceInformation.md) | | [optional] +**id** | **string** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid | +**submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. | +**status** | **string** | Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` | +**errorInformation** | [**\CyberSource\Model\InlineResponse2018ErrorInformation**](InlineResponse2018ErrorInformation.md) | | [optional] +**orderInformation** | [**\CyberSource\Model\InlineResponse2018OrderInformation**](InlineResponse2018OrderInformation.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) + + diff --git a/docs/Model/InlineResponse20014ClientReferenceInformation.md b/docs/Model/InlineResponse20015ClientReferenceInformation.md similarity index 96% rename from docs/Model/InlineResponse20014ClientReferenceInformation.md rename to docs/Model/InlineResponse20015ClientReferenceInformation.md index b2302fb87..45e3f3d06 100644 --- a/docs/Model/InlineResponse20014ClientReferenceInformation.md +++ b/docs/Model/InlineResponse20015ClientReferenceInformation.md @@ -1,4 +1,4 @@ -# InlineResponse20014ClientReferenceInformation +# InlineResponse20015ClientReferenceInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse200Content.md b/docs/Model/InlineResponse2001Content.md similarity index 95% rename from docs/Model/InlineResponse200Content.md rename to docs/Model/InlineResponse2001Content.md index c8c150b64..1c36b5c51 100644 --- a/docs/Model/InlineResponse200Content.md +++ b/docs/Model/InlineResponse2001Content.md @@ -1,4 +1,4 @@ -# InlineResponse200Content +# InlineResponse2001Content ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse2001Embedded.md b/docs/Model/InlineResponse2001Embedded.md deleted file mode 100644 index 3be818713..000000000 --- a/docs/Model/InlineResponse2001Embedded.md +++ /dev/null @@ -1,11 +0,0 @@ -# InlineResponse2001Embedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capture** | [**\CyberSource\Model\InlineResponse2001EmbeddedCapture**](InlineResponse2001EmbeddedCapture.md) | | [optional] -**reversal** | [**\CyberSource\Model\InlineResponse2001EmbeddedReversal**](InlineResponse2001EmbeddedReversal.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) - - diff --git a/docs/Model/InlineResponse2002.md b/docs/Model/InlineResponse2002.md index dc84a5491..a5ba1420c 100644 --- a/docs/Model/InlineResponse2002.md +++ b/docs/Model/InlineResponse2002.md @@ -3,18 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] -**fieldType** | **string** | | [optional] -**label** | **string** | | [optional] -**customerVisible** | **bool** | | [optional] -**textMinLength** | **int** | | [optional] -**textMaxLength** | **int** | | [optional] -**possibleValues** | **string** | | [optional] -**textDefaultValue** | **string** | | [optional] -**merchantId** | **string** | | [optional] -**referenceType** | **string** | | [optional] -**readOnly** | **bool** | | [optional] -**merchantDefinedDataIndex** | **int** | | [optional] +**id** | **string** | UUID uniquely generated for this comments. | [optional] +**submitTimeUtc** | **string** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **string** | The status of the submitted transaction. Possible values are: - `ACCEPTED` - `REJECTED` | [optional] +**embedded** | [**\CyberSource\Model\InlineResponse2002Embedded**](InlineResponse2002Embedded.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) diff --git a/docs/Model/InlineResponse2002Embedded.md b/docs/Model/InlineResponse2002Embedded.md new file mode 100644 index 000000000..7365060a1 --- /dev/null +++ b/docs/Model/InlineResponse2002Embedded.md @@ -0,0 +1,11 @@ +# InlineResponse2002Embedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**capture** | [**\CyberSource\Model\InlineResponse2002EmbeddedCapture**](InlineResponse2002EmbeddedCapture.md) | | [optional] +**reversal** | [**\CyberSource\Model\InlineResponse2002EmbeddedReversal**](InlineResponse2002EmbeddedReversal.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) + + diff --git a/docs/Model/InlineResponse2001EmbeddedCapture.md b/docs/Model/InlineResponse2002EmbeddedCapture.md similarity index 69% rename from docs/Model/InlineResponse2001EmbeddedCapture.md rename to docs/Model/InlineResponse2002EmbeddedCapture.md index 4818c61dc..c21df1f99 100644 --- a/docs/Model/InlineResponse2001EmbeddedCapture.md +++ b/docs/Model/InlineResponse2002EmbeddedCapture.md @@ -1,10 +1,10 @@ -# InlineResponse2001EmbeddedCapture +# InlineResponse2002EmbeddedCapture ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **string** | The status of the capture if the capture is called. | [optional] -**links** | [**\CyberSource\Model\InlineResponse2001EmbeddedCaptureLinks**](InlineResponse2001EmbeddedCaptureLinks.md) | | [optional] +**links** | [**\CyberSource\Model\InlineResponse2002EmbeddedCaptureLinks**](InlineResponse2002EmbeddedCaptureLinks.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) diff --git a/docs/Model/InlineResponse2001EmbeddedCaptureLinks.md b/docs/Model/InlineResponse2002EmbeddedCaptureLinks.md similarity index 63% rename from docs/Model/InlineResponse2001EmbeddedCaptureLinks.md rename to docs/Model/InlineResponse2002EmbeddedCaptureLinks.md index 779ab37bc..742547e2a 100644 --- a/docs/Model/InlineResponse2001EmbeddedCaptureLinks.md +++ b/docs/Model/InlineResponse2002EmbeddedCaptureLinks.md @@ -1,9 +1,9 @@ -# InlineResponse2001EmbeddedCaptureLinks +# InlineResponse2002EmbeddedCaptureLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**self** | [**\CyberSource\Model\InlineResponse2001EmbeddedCaptureLinksSelf**](InlineResponse2001EmbeddedCaptureLinksSelf.md) | | [optional] +**self** | [**\CyberSource\Model\InlineResponse2002EmbeddedCaptureLinksSelf**](InlineResponse2002EmbeddedCaptureLinksSelf.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) diff --git a/docs/Model/InlineResponse2001EmbeddedCaptureLinksSelf.md b/docs/Model/InlineResponse2002EmbeddedCaptureLinksSelf.md similarity index 92% rename from docs/Model/InlineResponse2001EmbeddedCaptureLinksSelf.md rename to docs/Model/InlineResponse2002EmbeddedCaptureLinksSelf.md index d0b5c175d..02793836c 100644 --- a/docs/Model/InlineResponse2001EmbeddedCaptureLinksSelf.md +++ b/docs/Model/InlineResponse2002EmbeddedCaptureLinksSelf.md @@ -1,4 +1,4 @@ -# InlineResponse2001EmbeddedCaptureLinksSelf +# InlineResponse2002EmbeddedCaptureLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse2001EmbeddedReversal.md b/docs/Model/InlineResponse2002EmbeddedReversal.md similarity index 69% rename from docs/Model/InlineResponse2001EmbeddedReversal.md rename to docs/Model/InlineResponse2002EmbeddedReversal.md index 604942aef..b3fc41100 100644 --- a/docs/Model/InlineResponse2001EmbeddedReversal.md +++ b/docs/Model/InlineResponse2002EmbeddedReversal.md @@ -1,10 +1,10 @@ -# InlineResponse2001EmbeddedReversal +# InlineResponse2002EmbeddedReversal ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **string** | The status of the reversal if the auth reversal is called. | [optional] -**links** | [**\CyberSource\Model\InlineResponse2001EmbeddedReversalLinks**](InlineResponse2001EmbeddedReversalLinks.md) | | [optional] +**links** | [**\CyberSource\Model\InlineResponse2002EmbeddedReversalLinks**](InlineResponse2002EmbeddedReversalLinks.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) diff --git a/docs/Model/InlineResponse2001EmbeddedReversalLinks.md b/docs/Model/InlineResponse2002EmbeddedReversalLinks.md similarity index 63% rename from docs/Model/InlineResponse2001EmbeddedReversalLinks.md rename to docs/Model/InlineResponse2002EmbeddedReversalLinks.md index 65b8b4070..29771358a 100644 --- a/docs/Model/InlineResponse2001EmbeddedReversalLinks.md +++ b/docs/Model/InlineResponse2002EmbeddedReversalLinks.md @@ -1,9 +1,9 @@ -# InlineResponse2001EmbeddedReversalLinks +# InlineResponse2002EmbeddedReversalLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**self** | [**\CyberSource\Model\InlineResponse2001EmbeddedReversalLinksSelf**](InlineResponse2001EmbeddedReversalLinksSelf.md) | | [optional] +**self** | [**\CyberSource\Model\InlineResponse2002EmbeddedReversalLinksSelf**](InlineResponse2002EmbeddedReversalLinksSelf.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) diff --git a/docs/Model/InlineResponse2001EmbeddedReversalLinksSelf.md b/docs/Model/InlineResponse2002EmbeddedReversalLinksSelf.md similarity index 92% rename from docs/Model/InlineResponse2001EmbeddedReversalLinksSelf.md rename to docs/Model/InlineResponse2002EmbeddedReversalLinksSelf.md index 41f52eacc..b6f3f881d 100644 --- a/docs/Model/InlineResponse2001EmbeddedReversalLinksSelf.md +++ b/docs/Model/InlineResponse2002EmbeddedReversalLinksSelf.md @@ -1,4 +1,4 @@ -# InlineResponse2001EmbeddedReversalLinksSelf +# InlineResponse2002EmbeddedReversalLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse2003.md b/docs/Model/InlineResponse2003.md index 3476d44ef..6a79aec7e 100644 --- a/docs/Model/InlineResponse2003.md +++ b/docs/Model/InlineResponse2003.md @@ -3,13 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**registrationInformation** | [**\CyberSource\Model\Boardingv1registrationsRegistrationInformation**](Boardingv1registrationsRegistrationInformation.md) | | [optional] -**integrationInformation** | [**\CyberSource\Model\InlineResponse2003IntegrationInformation**](InlineResponse2003IntegrationInformation.md) | | [optional] -**organizationInformation** | [**\CyberSource\Model\Boardingv1registrationsOrganizationInformation**](Boardingv1registrationsOrganizationInformation.md) | | [optional] -**productInformation** | [**\CyberSource\Model\Boardingv1registrationsProductInformation**](Boardingv1registrationsProductInformation.md) | | [optional] -**productInformationSetups** | [**\CyberSource\Model\InlineResponse2013ProductInformationSetups[]**](InlineResponse2013ProductInformationSetups.md) | | [optional] -**documentInformation** | [**\CyberSource\Model\Boardingv1registrationsDocumentInformation**](Boardingv1registrationsDocumentInformation.md) | | [optional] -**details** | [**map[string,object[]]**](array.md) | | [optional] +**id** | **int** | | [optional] +**fieldType** | **string** | | [optional] +**label** | **string** | | [optional] +**customerVisible** | **bool** | | [optional] +**textMinLength** | **int** | | [optional] +**textMaxLength** | **int** | | [optional] +**possibleValues** | **string** | | [optional] +**textDefaultValue** | **string** | | [optional] +**merchantId** | **string** | | [optional] +**referenceType** | **string** | | [optional] +**readOnly** | **bool** | | [optional] +**merchantDefinedDataIndex** | **int** | | [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) diff --git a/docs/Model/InlineResponse2004.md b/docs/Model/InlineResponse2004.md index e9dda5321..ed8882dce 100644 --- a/docs/Model/InlineResponse2004.md +++ b/docs/Model/InlineResponse2004.md @@ -3,9 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **string** | Product ID. | [optional] -**productName** | **string** | Product Name. | [optional] -**eventTypes** | [**\CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[]**](Notificationsubscriptionsv2productsorganizationIdEventTypes.md) | | [optional] +**registrationInformation** | [**\CyberSource\Model\Boardingv1registrationsRegistrationInformation**](Boardingv1registrationsRegistrationInformation.md) | | [optional] +**integrationInformation** | [**\CyberSource\Model\InlineResponse2004IntegrationInformation**](InlineResponse2004IntegrationInformation.md) | | [optional] +**organizationInformation** | [**\CyberSource\Model\Boardingv1registrationsOrganizationInformation**](Boardingv1registrationsOrganizationInformation.md) | | [optional] +**productInformation** | [**\CyberSource\Model\Boardingv1registrationsProductInformation**](Boardingv1registrationsProductInformation.md) | | [optional] +**productInformationSetups** | [**\CyberSource\Model\InlineResponse2013ProductInformationSetups[]**](InlineResponse2013ProductInformationSetups.md) | | [optional] +**documentInformation** | [**\CyberSource\Model\Boardingv1registrationsDocumentInformation**](Boardingv1registrationsDocumentInformation.md) | | [optional] +**details** | [**map[string,object[]]**](array.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) diff --git a/docs/Model/InlineResponse2003IntegrationInformation.md b/docs/Model/InlineResponse2004IntegrationInformation.md similarity index 78% rename from docs/Model/InlineResponse2003IntegrationInformation.md rename to docs/Model/InlineResponse2004IntegrationInformation.md index 52decaf94..86e3ab509 100644 --- a/docs/Model/InlineResponse2003IntegrationInformation.md +++ b/docs/Model/InlineResponse2004IntegrationInformation.md @@ -1,10 +1,10 @@ -# InlineResponse2003IntegrationInformation +# InlineResponse2004IntegrationInformation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **oauth2** | [**\CyberSource\Model\Boardingv1registrationsIntegrationInformationOauth2[]**](Boardingv1registrationsIntegrationInformationOauth2.md) | | [optional] -**tenantConfigurations** | [**\CyberSource\Model\InlineResponse2003IntegrationInformationTenantConfigurations[]**](InlineResponse2003IntegrationInformationTenantConfigurations.md) | tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. | [optional] +**tenantConfigurations** | [**\CyberSource\Model\InlineResponse2004IntegrationInformationTenantConfigurations[]**](InlineResponse2004IntegrationInformationTenantConfigurations.md) | tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. | [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) diff --git a/docs/Model/InlineResponse2003IntegrationInformationTenantConfigurations.md b/docs/Model/InlineResponse2004IntegrationInformationTenantConfigurations.md similarity index 94% rename from docs/Model/InlineResponse2003IntegrationInformationTenantConfigurations.md rename to docs/Model/InlineResponse2004IntegrationInformationTenantConfigurations.md index 1ea9e9480..d0e5471f0 100644 --- a/docs/Model/InlineResponse2003IntegrationInformationTenantConfigurations.md +++ b/docs/Model/InlineResponse2004IntegrationInformationTenantConfigurations.md @@ -1,4 +1,4 @@ -# InlineResponse2003IntegrationInformationTenantConfigurations +# InlineResponse2004IntegrationInformationTenantConfigurations ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse2005.md b/docs/Model/InlineResponse2005.md index 568140adf..ddcdf2624 100644 --- a/docs/Model/InlineResponse2005.md +++ b/docs/Model/InlineResponse2005.md @@ -3,18 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**webhookId** | **string** | Webhook Id. This is generated by the server. | [optional] -**organizationId** | **string** | Organization ID. | [optional] -**products** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[]**](Notificationsubscriptionsv2webhooksProducts.md) | | [optional] -**webhookUrl** | **string** | The client's endpoint (URL) to receive webhooks. | [optional] -**healthCheckUrl** | **string** | The client's health check endpoint (URL). | [optional] -**status** | **string** | Webhook status. | [optional] [default to 'INACTIVE'] -**name** | **string** | Client friendly webhook name. | [optional] -**description** | **string** | Client friendly webhook description. | [optional] -**retryPolicy** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy**](Notificationsubscriptionsv2webhooksRetryPolicy.md) | | [optional] -**securityPolicy** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy**](Notificationsubscriptionsv2webhooksSecurityPolicy.md) | | [optional] -**createdOn** | **string** | Date on which webhook was created/registered. | [optional] -**notificationScope** | **string** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS | [optional] [default to 'DESCENDANTS'] +**productId** | **string** | Product ID. | [optional] +**productName** | **string** | Product Name. | [optional] +**eventTypes** | [**\CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[]**](Notificationsubscriptionsv2productsorganizationIdEventTypes.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) diff --git a/docs/Model/InlineResponse2006.md b/docs/Model/InlineResponse2006.md index 89e699d3d..0ec6bf8a9 100644 --- a/docs/Model/InlineResponse2006.md +++ b/docs/Model/InlineResponse2006.md @@ -14,7 +14,6 @@ Name | Type | Description | Notes **retryPolicy** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy**](Notificationsubscriptionsv2webhooksRetryPolicy.md) | | [optional] **securityPolicy** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy**](Notificationsubscriptionsv2webhooksSecurityPolicy.md) | | [optional] **createdOn** | **string** | Date on which webhook was created/registered. | [optional] -**updatedOn** | **string** | Date on which webhook was most recently updated. | [optional] **notificationScope** | **string** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS | [optional] [default to 'DESCENDANTS'] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/InlineResponse2007.md b/docs/Model/InlineResponse2007.md index 5a30d6c79..031c8928f 100644 --- a/docs/Model/InlineResponse2007.md +++ b/docs/Model/InlineResponse2007.md @@ -3,12 +3,19 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalCount** | **int** | Total number of results. | [optional] -**offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] -**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] -**sort** | **string** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional] -**count** | **int** | Results for this page, this could be below the limit. | [optional] -**devices** | [**\CyberSource\Model\InlineResponse2007Devices[]**](InlineResponse2007Devices.md) | A collection of devices | [optional] +**webhookId** | **string** | Webhook Id. This is generated by the server. | [optional] +**organizationId** | **string** | Organization ID. | [optional] +**products** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[]**](Notificationsubscriptionsv2webhooksProducts.md) | | [optional] +**webhookUrl** | **string** | The client's endpoint (URL) to receive webhooks. | [optional] +**healthCheckUrl** | **string** | The client's health check endpoint (URL). | [optional] +**status** | **string** | Webhook status. | [optional] [default to 'INACTIVE'] +**name** | **string** | Client friendly webhook name. | [optional] +**description** | **string** | Client friendly webhook description. | [optional] +**retryPolicy** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy**](Notificationsubscriptionsv2webhooksRetryPolicy.md) | | [optional] +**securityPolicy** | [**\CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy**](Notificationsubscriptionsv2webhooksSecurityPolicy.md) | | [optional] +**createdOn** | **string** | Date on which webhook was created/registered. | [optional] +**updatedOn** | **string** | Date on which webhook was most recently updated. | [optional] +**notificationScope** | **string** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS | [optional] [default to 'DESCENDANTS'] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Model/InlineResponse2008.md b/docs/Model/InlineResponse2008.md index 380bfe407..ac6719009 100644 --- a/docs/Model/InlineResponse2008.md +++ b/docs/Model/InlineResponse2008.md @@ -3,8 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | Possible values: - OK | [optional] -**devices** | [**\CyberSource\Model\Dmsv3devicesdeassociateDevices[]**](Dmsv3devicesdeassociateDevices.md) | | [optional] +**totalCount** | **int** | Total number of results. | [optional] +**offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] +**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] +**sort** | **string** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional] +**count** | **int** | Results for this page, this could be below the limit. | [optional] +**devices** | [**\CyberSource\Model\InlineResponse2008Devices[]**](InlineResponse2008Devices.md) | A collection of devices | [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) diff --git a/docs/Model/InlineResponse2007Devices.md b/docs/Model/InlineResponse2008Devices.md similarity index 96% rename from docs/Model/InlineResponse2007Devices.md rename to docs/Model/InlineResponse2008Devices.md index fa411edce..3d4da6154 100644 --- a/docs/Model/InlineResponse2007Devices.md +++ b/docs/Model/InlineResponse2008Devices.md @@ -1,4 +1,4 @@ -# InlineResponse2007Devices +# InlineResponse2008Devices ## Properties Name | Type | Description | Notes diff --git a/docs/Model/InlineResponse2009.md b/docs/Model/InlineResponse2009.md index 4e99d34e6..115993650 100644 --- a/docs/Model/InlineResponse2009.md +++ b/docs/Model/InlineResponse2009.md @@ -3,12 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalCount** | **int** | Total number of results. | [optional] -**offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] -**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] -**sort** | **string** | A comma separated list of the following form: `terminalCreationDate:desc or serialNumber or terminalUpdationDate` | [optional] -**count** | **int** | Results for this page, this could be below the limit. | [optional] -**devices** | [**\CyberSource\Model\InlineResponse2009Devices[]**](InlineResponse2009Devices.md) | A collection of devices | [optional] +**status** | **string** | Possible values: - OK | [optional] +**devices** | [**\CyberSource\Model\Dmsv3devicesdeassociateDevices[]**](Dmsv3devicesdeassociateDevices.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) diff --git a/docs/Model/InlineResponse200Details.md b/docs/Model/InlineResponse200Details.md new file mode 100644 index 000000000..f2ac8327a --- /dev/null +++ b/docs/Model/InlineResponse200Details.md @@ -0,0 +1,11 @@ +# InlineResponse200Details + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the field that caused the error. | [optional] +**location** | **string** | The location of the field that caused the error. | [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) + + diff --git a/docs/Model/InlineResponse200Errors.md b/docs/Model/InlineResponse200Errors.md new file mode 100644 index 000000000..1e52ed6a9 --- /dev/null +++ b/docs/Model/InlineResponse200Errors.md @@ -0,0 +1,12 @@ +# InlineResponse200Errors + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of error. Possible Values: - invalidHeaders - missingHeaders - invalidFields - missingFields - unsupportedPaymentMethodModification - invalidCombination - forbidden - notFound - instrumentIdentifierDeletionError - tokenIdConflict - conflict - notAvailable - serverError - notAttempted A \"notAttempted\" error type is returned when the request cannot be processed because it depends on the existence of another token that does not exist. For example, creating a shipping address token is not attempted if the required customer token is missing. | [optional] +**message** | **string** | The detailed message related to the type. | [optional] +**details** | [**\CyberSource\Model\InlineResponse200Details[]**](InlineResponse200Details.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) + + diff --git a/docs/Model/InlineResponse200Responses.md b/docs/Model/InlineResponse200Responses.md new file mode 100644 index 000000000..72570f831 --- /dev/null +++ b/docs/Model/InlineResponse200Responses.md @@ -0,0 +1,13 @@ +# InlineResponse200Responses + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resource** | **string** | TMS token type associated with the response. Possible Values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress - tokenizedCard | [optional] +**httpStatus** | **int** | Http status associated with the response. | [optional] +**id** | **string** | TMS token id associated with the response. | [optional] +**errors** | [**\CyberSource\Model\InlineResponse200Errors[]**](InlineResponse200Errors.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) + + diff --git a/docs/Model/InlineResponse2013SetupsPayments.md b/docs/Model/InlineResponse2013SetupsPayments.md index db33441d2..8cbdced3e 100644 --- a/docs/Model/InlineResponse2013SetupsPayments.md +++ b/docs/Model/InlineResponse2013SetupsPayments.md @@ -22,6 +22,7 @@ Name | Type | Description | Notes **unifiedCheckout** | [**\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments**](InlineResponse2013SetupsPaymentsDigitalPayments.md) | | [optional] **receivablesManager** | [**\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments**](InlineResponse2013SetupsPaymentsDigitalPayments.md) | | [optional] **serviceFee** | [**\CyberSource\Model\InlineResponse2013SetupsPaymentsCardProcessing**](InlineResponse2013SetupsPaymentsCardProcessing.md) | | [optional] +**batchUpload** | [**\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments**](InlineResponse2013SetupsPaymentsDigitalPayments.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) diff --git a/docs/Model/PatchCustomerPaymentInstrumentRequest.md b/docs/Model/PatchCustomerPaymentInstrumentRequest.md index a5e4046e4..16f95bb07 100644 --- a/docs/Model/PatchCustomerPaymentInstrumentRequest.md +++ b/docs/Model/PatchCustomerPaymentInstrumentRequest.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] **id** | **string** | The Id of the Payment Instrument Token. | [optional] **object** | **string** | The type. Possible Values: - paymentInstrument | [optional] **default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bankAccount** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**bankAccount** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] **processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md) | | [optional] +**merchantInformation** | [**\CyberSource\Model\TmsMerchantInformation**](TmsMerchantInformation.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.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) diff --git a/docs/Model/PatchCustomerRequest.md b/docs/Model/PatchCustomerRequest.md index 7a7ea9e85..380681486 100644 --- a/docs/Model/PatchCustomerRequest.md +++ b/docs/Model/PatchCustomerRequest.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersLinks**](Tmsv2customersLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks**](Tmsv2tokenizeTokenInformationCustomerLinks.md) | | [optional] **id** | **string** | The Id of the Customer Token. | [optional] -**objectInformation** | [**\CyberSource\Model\Tmsv2customersObjectInformation**](Tmsv2customersObjectInformation.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersBuyerInformation**](Tmsv2customersBuyerInformation.md) | | [optional] -**clientReferenceInformation** | [**\CyberSource\Model\Tmsv2customersClientReferenceInformation**](Tmsv2customersClientReferenceInformation.md) | | [optional] -**merchantDefinedInformation** | [**\CyberSource\Model\Tmsv2customersMerchantDefinedInformation[]**](Tmsv2customersMerchantDefinedInformation.md) | Object containing the custom data that the merchant defines. | [optional] -**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2customersDefaultPaymentInstrument**](Tmsv2customersDefaultPaymentInstrument.md) | | [optional] -**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2customersDefaultShippingAddress**](Tmsv2customersDefaultShippingAddress.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersMetadata**](Tmsv2customersMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbedded**](Tmsv2customersEmbedded.md) | | [optional] +**objectInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation**](Tmsv2tokenizeTokenInformationCustomerObjectInformation.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerBuyerInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation**](Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation.md) | | [optional] +**merchantDefinedInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[]**](Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation.md) | Object containing the custom data that the merchant defines. | [optional] +**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument**](Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument.md) | | [optional] +**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress**](Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata**](Tmsv2tokenizeTokenInformationCustomerMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbedded.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) diff --git a/docs/Model/PatchCustomerShippingAddressRequest.md b/docs/Model/PatchCustomerShippingAddressRequest.md index 25db9acb5..f1b03b6c5 100644 --- a/docs/Model/PatchCustomerShippingAddressRequest.md +++ b/docs/Model/PatchCustomerShippingAddressRequest.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.md) | | [optional] **id** | **string** | The Id of the Shipping Address Token. | [optional] **default** | **bool** | Flag that indicates whether customer shipping address is the dafault. Possible Values: - `true`: Shipping Address is customer's default. - `false`: Shipping Address is not customer's default. | [optional] -**shipTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md) | | [optional] +**shipTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata.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) diff --git a/docs/Model/PatchPaymentInstrumentRequest.md b/docs/Model/PatchPaymentInstrumentRequest.md index ffe5cfe42..bb68f7b87 100644 --- a/docs/Model/PatchPaymentInstrumentRequest.md +++ b/docs/Model/PatchPaymentInstrumentRequest.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] **id** | **string** | The Id of the Payment Instrument Token. | [optional] **object** | **string** | The type. Possible Values: - paymentInstrument | [optional] **default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bankAccount** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**bankAccount** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] **processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md) | | [optional] +**merchantInformation** | [**\CyberSource\Model\TmsMerchantInformation**](TmsMerchantInformation.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.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) diff --git a/docs/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.md b/docs/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.md index 1401243db..10810aabf 100644 --- a/docs/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.md +++ b/docs/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.md @@ -3,20 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] **id** | **string** | The Id of the Payment Instrument Token. | [optional] **object** | **string** | The type. Possible Values: - paymentInstrument | [optional] **default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bankAccount** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**bankAccount** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] **processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**merchantInformation** | [**\CyberSource\Model\TmsMerchantInformation**](TmsMerchantInformation.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] **embedded** | [**\CyberSource\Model\PaymentInstrumentList1EmbeddedEmbedded**](PaymentInstrumentList1EmbeddedEmbedded.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) diff --git a/docs/Model/PaymentInstrumentListEmbedded.md b/docs/Model/PaymentInstrumentListEmbedded.md index 6e31bd8a1..34a5a3218 100644 --- a/docs/Model/PaymentInstrumentListEmbedded.md +++ b/docs/Model/PaymentInstrumentListEmbedded.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**paymentInstruments** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument[]**](Tmsv2customersEmbeddedDefaultPaymentInstrument.md) | | [optional] +**paymentInstruments** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument[]**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.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) diff --git a/docs/Model/PaymentsProducts.md b/docs/Model/PaymentsProducts.md index 60aeaf049..8df962c44 100644 --- a/docs/Model/PaymentsProducts.md +++ b/docs/Model/PaymentsProducts.md @@ -23,6 +23,7 @@ Name | Type | Description | Notes **unifiedCheckout** | [**\CyberSource\Model\PaymentsProductsUnifiedCheckout**](PaymentsProductsUnifiedCheckout.md) | | [optional] **receivablesManager** | [**\CyberSource\Model\PaymentsProductsTax**](PaymentsProductsTax.md) | | [optional] **serviceFee** | [**\CyberSource\Model\PaymentsProductsServiceFee**](PaymentsProductsServiceFee.md) | | [optional] +**batchUpload** | [**\CyberSource\Model\PaymentsProductsTax**](PaymentsProductsTax.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) diff --git a/docs/Model/PostCustomerPaymentInstrumentRequest.md b/docs/Model/PostCustomerPaymentInstrumentRequest.md index 9ca3544bf..2dc6d28d3 100644 --- a/docs/Model/PostCustomerPaymentInstrumentRequest.md +++ b/docs/Model/PostCustomerPaymentInstrumentRequest.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] **id** | **string** | The Id of the Payment Instrument Token. | [optional] **object** | **string** | The type. Possible Values: - paymentInstrument | [optional] **default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bankAccount** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**bankAccount** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] **processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md) | | [optional] +**merchantInformation** | [**\CyberSource\Model\TmsMerchantInformation**](TmsMerchantInformation.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.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) diff --git a/docs/Model/PostCustomerRequest.md b/docs/Model/PostCustomerRequest.md index 48b4b4e68..8bca2bcb1 100644 --- a/docs/Model/PostCustomerRequest.md +++ b/docs/Model/PostCustomerRequest.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersLinks**](Tmsv2customersLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks**](Tmsv2tokenizeTokenInformationCustomerLinks.md) | | [optional] **id** | **string** | The Id of the Customer Token. | [optional] -**objectInformation** | [**\CyberSource\Model\Tmsv2customersObjectInformation**](Tmsv2customersObjectInformation.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersBuyerInformation**](Tmsv2customersBuyerInformation.md) | | [optional] -**clientReferenceInformation** | [**\CyberSource\Model\Tmsv2customersClientReferenceInformation**](Tmsv2customersClientReferenceInformation.md) | | [optional] -**merchantDefinedInformation** | [**\CyberSource\Model\Tmsv2customersMerchantDefinedInformation[]**](Tmsv2customersMerchantDefinedInformation.md) | Object containing the custom data that the merchant defines. | [optional] -**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2customersDefaultPaymentInstrument**](Tmsv2customersDefaultPaymentInstrument.md) | | [optional] -**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2customersDefaultShippingAddress**](Tmsv2customersDefaultShippingAddress.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersMetadata**](Tmsv2customersMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbedded**](Tmsv2customersEmbedded.md) | | [optional] +**objectInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation**](Tmsv2tokenizeTokenInformationCustomerObjectInformation.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerBuyerInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation**](Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation.md) | | [optional] +**merchantDefinedInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[]**](Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation.md) | Object containing the custom data that the merchant defines. | [optional] +**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument**](Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument.md) | | [optional] +**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress**](Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata**](Tmsv2tokenizeTokenInformationCustomerMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbedded.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) diff --git a/docs/Model/PostCustomerShippingAddressRequest.md b/docs/Model/PostCustomerShippingAddressRequest.md index 17f33095a..ae0371668 100644 --- a/docs/Model/PostCustomerShippingAddressRequest.md +++ b/docs/Model/PostCustomerShippingAddressRequest.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.md) | | [optional] **id** | **string** | The Id of the Shipping Address Token. | [optional] **default** | **bool** | Flag that indicates whether customer shipping address is the dafault. Possible Values: - `true`: Shipping Address is customer's default. - `false`: Shipping Address is not customer's default. | [optional] -**shipTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md) | | [optional] +**shipTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata.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) diff --git a/docs/Model/PostIssuerLifeCycleSimulationRequest.md b/docs/Model/PostIssuerLifeCycleSimulationRequest.md new file mode 100644 index 000000000..27a94bb13 --- /dev/null +++ b/docs/Model/PostIssuerLifeCycleSimulationRequest.md @@ -0,0 +1,12 @@ +# PostIssuerLifeCycleSimulationRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **string** | The new state of the Tokenized Card. Possible Values: - ACTIVE - SUSPENDED - DELETED | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.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) + + diff --git a/docs/Model/PostPaymentInstrumentRequest.md b/docs/Model/PostPaymentInstrumentRequest.md index 427f33208..fc1d1a3a4 100644 --- a/docs/Model/PostPaymentInstrumentRequest.md +++ b/docs/Model/PostPaymentInstrumentRequest.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] **id** | **string** | The Id of the Payment Instrument Token. | [optional] **object** | **string** | The type. Possible Values: - paymentInstrument | [optional] **default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] **state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] **type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bankAccount** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**bankAccount** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] **processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md) | | [optional] +**merchantInformation** | [**\CyberSource\Model\TmsMerchantInformation**](TmsMerchantInformation.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.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) diff --git a/docs/Model/PostTokenizeRequest.md b/docs/Model/PostTokenizeRequest.md new file mode 100644 index 000000000..e8766ae80 --- /dev/null +++ b/docs/Model/PostTokenizeRequest.md @@ -0,0 +1,11 @@ +# PostTokenizeRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processingInformation** | [**\CyberSource\Model\Tmsv2tokenizeProcessingInformation**](Tmsv2tokenizeProcessingInformation.md) | | [optional] +**tokenInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformation**](Tmsv2tokenizeTokenInformation.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) + + diff --git a/docs/Model/Ptsv2paymentsAggregatorInformation.md b/docs/Model/Ptsv2paymentsAggregatorInformation.md index 3ed2a33c6..96a5bb6c7 100644 --- a/docs/Model/Ptsv2paymentsAggregatorInformation.md +++ b/docs/Model/Ptsv2paymentsAggregatorInformation.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **state** | **string** | Acquirer state. | [optional] **postalCode** | **string** | Acquirer postal code. | [optional] **country** | **string** | Acquirer country. | [optional] +**serviceProvidername** | **string** | Contains transfer service provider name. | [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) diff --git a/docs/Model/Rbsv1plansClientReferenceInformation.md b/docs/Model/Rbsv1plansClientReferenceInformation.md deleted file mode 100644 index 8af4db2b9..000000000 --- a/docs/Model/Rbsv1plansClientReferenceInformation.md +++ /dev/null @@ -1,14 +0,0 @@ -# Rbsv1plansClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comments** | **string** | Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**\CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] -**applicationName** | **string** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] -**applicationVersion** | **string** | Version of the CyberSource application or integration used for a transaction. | [optional] -**applicationUser** | **string** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [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) - - diff --git a/docs/Model/Rbsv1subscriptionsClientReferenceInformation.md b/docs/Model/Rbsv1subscriptionsClientReferenceInformation.md deleted file mode 100644 index 2f45cb9ec..000000000 --- a/docs/Model/Rbsv1subscriptionsClientReferenceInformation.md +++ /dev/null @@ -1,15 +0,0 @@ -# Rbsv1subscriptionsClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **string** | > Deprecated: This field is ignored. Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] -**comments** | **string** | > Deprecated: This field is ignored. Brief description of the order or any comment you wish to add to the order. | [optional] -**partner** | [**\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformationPartner**](Rbsv1subscriptionsClientReferenceInformationPartner.md) | | [optional] -**applicationName** | **string** | > Deprecated: This field is ignored. The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] -**applicationVersion** | **string** | > Deprecated: This field is ignored. Version of the CyberSource application or integration used for a transaction. | [optional] -**applicationUser** | **string** | > Deprecated: This field is ignored. The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [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) - - diff --git a/docs/Model/Rbsv1subscriptionsClientReferenceInformationPartner.md b/docs/Model/Rbsv1subscriptionsClientReferenceInformationPartner.md deleted file mode 100644 index 52e1f2dc9..000000000 --- a/docs/Model/Rbsv1subscriptionsClientReferenceInformationPartner.md +++ /dev/null @@ -1,11 +0,0 @@ -# Rbsv1subscriptionsClientReferenceInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**developerId** | **string** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. | [optional] -**solutionId** | **string** | > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [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) - - diff --git a/docs/Model/ShippingAddressListForCustomerEmbedded.md b/docs/Model/ShippingAddressListForCustomerEmbedded.md index 4429c09d7..31fddb020 100644 --- a/docs/Model/ShippingAddressListForCustomerEmbedded.md +++ b/docs/Model/ShippingAddressListForCustomerEmbedded.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**shippingAddresses** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress[]**](Tmsv2customersEmbeddedDefaultShippingAddress.md) | | [optional] +**shippingAddresses** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress[]**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress.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) diff --git a/docs/Model/InlineResponse20010Links.md b/docs/Model/TmsMerchantInformation.md similarity index 60% rename from docs/Model/InlineResponse20010Links.md rename to docs/Model/TmsMerchantInformation.md index e753fceb9..384e15d6c 100644 --- a/docs/Model/InlineResponse20010Links.md +++ b/docs/Model/TmsMerchantInformation.md @@ -1,10 +1,9 @@ -# InlineResponse20010Links +# TmsMerchantInformation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**rel** | **string** | Valid Values: * self * first * last * prev * next | [optional] -**href** | **string** | | [optional] +**merchantDescriptor** | [**\CyberSource\Model\TmsMerchantInformationMerchantDescriptor**](TmsMerchantInformationMerchantDescriptor.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) diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md b/docs/Model/TmsMerchantInformationMerchantDescriptor.md similarity index 88% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md rename to docs/Model/TmsMerchantInformationMerchantDescriptor.md index ef7834e9c..1d2c9e469 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.md +++ b/docs/Model/TmsMerchantInformationMerchantDescriptor.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor +# TmsMerchantInformationMerchantDescriptor ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbedded.md b/docs/Model/Tmsv2customersEmbedded.md deleted file mode 100644 index 0b0f2aae5..000000000 --- a/docs/Model/Tmsv2customersEmbedded.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument**](Tmsv2customersEmbeddedDefaultPaymentInstrument.md) | | [optional] -**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress**](Tmsv2customersEmbeddedDefaultShippingAddress.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) - - diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrument.md b/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrument.md deleted file mode 100644 index 065a3f987..000000000 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrument.md +++ /dev/null @@ -1,24 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrument - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] -**id** | **string** | The Id of the Payment Instrument Token. | [optional] -**object** | **string** | The type. Possible Values: - paymentInstrument | [optional] -**default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] -**state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] -**type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] -**bankAccount** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] -**card** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] -**buyerInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] -**billTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] -**processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] -**merchantInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md) | | [optional] -**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] -**embedded** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.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) - - diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md b/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md deleted file mode 100644 index 3dcb4a8e9..000000000 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf**](Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md) | | [optional] -**customer** | [**\CyberSource\Model\Tmsv2customersLinksSelf**](Tmsv2customersLinksSelf.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) - - diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md b/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md deleted file mode 100644 index 39c770938..000000000 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantDescriptor** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor**](Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.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) - - diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddress.md b/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddress.md deleted file mode 100644 index f477c3275..000000000 --- a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddress.md +++ /dev/null @@ -1,14 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddress - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks**](Tmsv2customersEmbeddedDefaultShippingAddressLinks.md) | | [optional] -**id** | **string** | The Id of the Shipping Address Token. | [optional] -**default** | **bool** | Flag that indicates whether customer shipping address is the dafault. Possible Values: - `true`: Shipping Address is customer's default. - `false`: Shipping Address is not customer's default. | [optional] -**shipTo** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo**](Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md) | | [optional] -**metadata** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata**](Tmsv2customersEmbeddedDefaultShippingAddressMetadata.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) - - diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md b/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md deleted file mode 100644 index 955a498bd..000000000 --- a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinks.md +++ /dev/null @@ -1,11 +0,0 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf**](Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md) | | [optional] -**customer** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer**](Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.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) - - diff --git a/docs/Model/Tmsv2customersLinks.md b/docs/Model/Tmsv2customersLinks.md deleted file mode 100644 index e5f58c615..000000000 --- a/docs/Model/Tmsv2customersLinks.md +++ /dev/null @@ -1,12 +0,0 @@ -# Tmsv2customersLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**\CyberSource\Model\Tmsv2customersLinksSelf**](Tmsv2customersLinksSelf.md) | | [optional] -**paymentInstruments** | [**\CyberSource\Model\Tmsv2customersLinksPaymentInstruments**](Tmsv2customersLinksPaymentInstruments.md) | | [optional] -**shippingAddress** | [**\CyberSource\Model\Tmsv2customersLinksShippingAddress**](Tmsv2customersLinksShippingAddress.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) - - diff --git a/docs/Model/Tmsv2tokenizeProcessingInformation.md b/docs/Model/Tmsv2tokenizeProcessingInformation.md new file mode 100644 index 000000000..1cd145c49 --- /dev/null +++ b/docs/Model/Tmsv2tokenizeProcessingInformation.md @@ -0,0 +1,11 @@ +# Tmsv2tokenizeProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**actionList** | **string[]** | Array of actions (one or more) to be included in the tokenize request. Possible Values: - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your tokenize request. | [optional] +**actionTokenTypes** | **string[]** | TMS tokens types you want to perform the action on. Possible Values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress - tokenizedCard | [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) + + diff --git a/docs/Model/Tmsv2tokenizeTokenInformation.md b/docs/Model/Tmsv2tokenizeTokenInformation.md new file mode 100644 index 000000000..9ba5b190a --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformation.md @@ -0,0 +1,15 @@ +# Tmsv2tokenizeTokenInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jti** | **string** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional] +**transientTokenJwt** | **string** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. | [optional] +**customer** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomer**](Tmsv2tokenizeTokenInformationCustomer.md) | | [optional] +**shippingAddress** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress.md) | | [optional] +**paymentInstrument** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\TmsEmbeddedInstrumentIdentifier**](TmsEmbeddedInstrumentIdentifier.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) + + diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomer.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomer.md new file mode 100644 index 000000000..bd22fe253 --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomer.md @@ -0,0 +1,19 @@ +# Tmsv2tokenizeTokenInformationCustomer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks**](Tmsv2tokenizeTokenInformationCustomerLinks.md) | | [optional] +**id** | **string** | The Id of the Customer Token. | [optional] +**objectInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation**](Tmsv2tokenizeTokenInformationCustomerObjectInformation.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerBuyerInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation**](Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation.md) | | [optional] +**merchantDefinedInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[]**](Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation.md) | Object containing the custom data that the merchant defines. | [optional] +**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument**](Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument.md) | | [optional] +**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress**](Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata**](Tmsv2tokenizeTokenInformationCustomerMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbedded.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) + + diff --git a/docs/Model/Tmsv2customersBuyerInformation.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerBuyerInformation.md similarity index 89% rename from docs/Model/Tmsv2customersBuyerInformation.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerBuyerInformation.md index d7afcb6fd..5c437cd02 100644 --- a/docs/Model/Tmsv2customersBuyerInformation.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerBuyerInformation.md @@ -1,4 +1,4 @@ -# Tmsv2customersBuyerInformation +# Tmsv2tokenizeTokenInformationCustomerBuyerInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersClientReferenceInformation.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation.md similarity index 84% rename from docs/Model/Tmsv2customersClientReferenceInformation.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation.md index 904cd8cf8..b8ee42ecb 100644 --- a/docs/Model/Tmsv2customersClientReferenceInformation.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation.md @@ -1,4 +1,4 @@ -# Tmsv2customersClientReferenceInformation +# Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersDefaultPaymentInstrument.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument.md similarity index 84% rename from docs/Model/Tmsv2customersDefaultPaymentInstrument.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument.md index fbe680c3d..847b6bcfa 100644 --- a/docs/Model/Tmsv2customersDefaultPaymentInstrument.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument.md @@ -1,4 +1,4 @@ -# Tmsv2customersDefaultPaymentInstrument +# Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersDefaultShippingAddress.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress.md similarity index 85% rename from docs/Model/Tmsv2customersDefaultShippingAddress.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress.md index f45dd4bb4..bcd5123e6 100644 --- a/docs/Model/Tmsv2customersDefaultShippingAddress.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress.md @@ -1,4 +1,4 @@ -# Tmsv2customersDefaultShippingAddress +# Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbedded.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbedded.md new file mode 100644 index 000000000..0e8920bc6 --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbedded.md @@ -0,0 +1,11 @@ +# Tmsv2tokenizeTokenInformationCustomerEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaultPaymentInstrument** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.md) | | [optional] +**defaultShippingAddress** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress.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) + + diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.md new file mode 100644 index 000000000..8b84ccb83 --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.md @@ -0,0 +1,24 @@ +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md) | | [optional] +**id** | **string** | The Id of the Payment Instrument Token. | [optional] +**object** | **string** | The type. Possible Values: - paymentInstrument | [optional] +**default** | **bool** | Flag that indicates whether customer payment instrument is the dafault. Possible Values: - `true`: Payment instrument is customer's default. - `false`: Payment instrument is not customer's default. | [optional] +**state** | **string** | Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed. | [optional] +**type** | **string** | The type of Payment Instrument. Possible Values: - cardHash | [optional] +**bankAccount** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md) | | [optional] +**card** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md) | | [optional] +**buyerInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md) | | [optional] +**billTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md) | | [optional] +**processingInformation** | [**\CyberSource\Model\TmsPaymentInstrumentProcessingInfo**](TmsPaymentInstrumentProcessingInfo.md) | | [optional] +**merchantInformation** | [**\CyberSource\Model\TmsMerchantInformation**](TmsMerchantInformation.md) | | [optional] +**instrumentIdentifier** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md) | | [optional] +**embedded** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.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) + + diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md similarity index 86% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md index b96f57907..a5694ec3f 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md similarity index 95% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md index 2e30b0c48..d4a3d5aff 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md similarity index 79% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md index 7e027e25e..07208d513 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation ## Properties Name | Type | Description | Notes @@ -6,7 +6,7 @@ Name | Type | Description | Notes **companyTaxID** | **string** | Company's tax identifier. This is only used for eCheck service. | [optional] **currency** | **string** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). # For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] **dateOfBirth** | [**\DateTime**](\DateTime.md) | Date of birth of the customer. Format: YYYY-MM-DD | [optional] -**personalIdentification** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md) | | [optional] +**personalIdentification** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.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) diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md similarity index 83% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md index 5b6102a61..597bb58c6 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md similarity index 55% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md index 88085501b..8feef98fa 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md @@ -1,11 +1,11 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | The value of the identification type. | [optional] **type** | **string** | The type of the identification. Possible Values: - driver license | [optional] -**issuedBy** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.md) | | [optional] +**issuedBy** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.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) diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md similarity index 91% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md index 66cdc3ed2..cceced14a 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentCard +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard ## Properties Name | Type | Description | Notes @@ -11,7 +11,7 @@ Name | Type | Description | Notes **startYear** | **string** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] **useAs** | **string** | 'Payment Instrument was created / updated as part of a pinless debit transaction.' | [optional] **hash** | **string** | Hash value representing the card. | [optional] -**tokenizedInformation** | [**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation**](Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md) | | [optional] +**tokenizedInformation** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.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) diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md similarity index 91% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md index e3edeb481..c3444a199 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.md similarity index 83% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.md index 12d11a776..850204160 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md similarity index 80% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md index a8c8e7021..ad1ce283f 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md new file mode 100644 index 000000000..9970ed9ed --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks.md @@ -0,0 +1,11 @@ +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**self** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.md) | | [optional] +**customer** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf**](Tmsv2tokenizeTokenInformationCustomerLinksSelf.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) + + diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.md similarity index 80% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.md index 19cdecb40..bc75f0a4f 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md similarity index 81% rename from docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md index 854e22fc4..2bd458f59 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress.md new file mode 100644 index 000000000..c4f6d7a1a --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress.md @@ -0,0 +1,14 @@ +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.md) | | [optional] +**id** | **string** | The Id of the Shipping Address Token. | [optional] +**default** | **bool** | Flag that indicates whether customer shipping address is the dafault. Possible Values: - `true`: Shipping Address is customer's default. - `false`: Shipping Address is not customer's default. | [optional] +**shipTo** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.md) | | [optional] +**metadata** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata.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) + + diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.md new file mode 100644 index 000000000..332336a4d --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.md @@ -0,0 +1,11 @@ +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**self** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf.md) | | [optional] +**customer** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer**](Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.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) + + diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.md similarity index 80% rename from docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.md index bbadaaad7..6491aa422 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf.md similarity index 81% rename from docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf.md index 0afab6208..cf2f7b7b3 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata.md similarity index 81% rename from docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata.md index d77c1f7f0..0f5dc7750 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressMetadata.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressMetadata +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.md similarity index 96% rename from docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.md index fc833a2c6..f566b5f75 100644 --- a/docs/Model/Tmsv2customersEmbeddedDefaultShippingAddressShipTo.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo.md @@ -1,4 +1,4 @@ -# Tmsv2customersEmbeddedDefaultShippingAddressShipTo +# Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinks.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinks.md new file mode 100644 index 000000000..79fabf753 --- /dev/null +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinks.md @@ -0,0 +1,12 @@ +# Tmsv2tokenizeTokenInformationCustomerLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**self** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf**](Tmsv2tokenizeTokenInformationCustomerLinksSelf.md) | | [optional] +**paymentInstruments** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments**](Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.md) | | [optional] +**shippingAddress** | [**\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress**](Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress.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) + + diff --git a/docs/Model/Tmsv2customersLinksPaymentInstruments.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.md similarity index 84% rename from docs/Model/Tmsv2customersLinksPaymentInstruments.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.md index 2686d74b6..b27790706 100644 --- a/docs/Model/Tmsv2customersLinksPaymentInstruments.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.md @@ -1,4 +1,4 @@ -# Tmsv2customersLinksPaymentInstruments +# Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersLinksSelf.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksSelf.md similarity index 87% rename from docs/Model/Tmsv2customersLinksSelf.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksSelf.md index 670ef0228..898deb4ca 100644 --- a/docs/Model/Tmsv2customersLinksSelf.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksSelf.md @@ -1,4 +1,4 @@ -# Tmsv2customersLinksSelf +# Tmsv2tokenizeTokenInformationCustomerLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersLinksShippingAddress.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress.md similarity index 85% rename from docs/Model/Tmsv2customersLinksShippingAddress.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress.md index 009626dbc..acc3ffa07 100644 --- a/docs/Model/Tmsv2customersLinksShippingAddress.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress.md @@ -1,4 +1,4 @@ -# Tmsv2customersLinksShippingAddress +# Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersMerchantDefinedInformation.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation.md similarity index 96% rename from docs/Model/Tmsv2customersMerchantDefinedInformation.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation.md index 84eb701da..6488eb8e9 100644 --- a/docs/Model/Tmsv2customersMerchantDefinedInformation.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation.md @@ -1,4 +1,4 @@ -# Tmsv2customersMerchantDefinedInformation +# Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersMetadata.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerMetadata.md similarity index 87% rename from docs/Model/Tmsv2customersMetadata.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerMetadata.md index f96ca9fd0..36810e847 100644 --- a/docs/Model/Tmsv2customersMetadata.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerMetadata.md @@ -1,4 +1,4 @@ -# Tmsv2customersMetadata +# Tmsv2tokenizeTokenInformationCustomerMetadata ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2customersObjectInformation.md b/docs/Model/Tmsv2tokenizeTokenInformationCustomerObjectInformation.md similarity index 88% rename from docs/Model/Tmsv2customersObjectInformation.md rename to docs/Model/Tmsv2tokenizeTokenInformationCustomerObjectInformation.md index 3928571f5..5e5274073 100644 --- a/docs/Model/Tmsv2customersObjectInformation.md +++ b/docs/Model/Tmsv2tokenizeTokenInformationCustomerObjectInformation.md @@ -1,4 +1,4 @@ -# Tmsv2customersObjectInformation +# Tmsv2tokenizeTokenInformationCustomerObjectInformation ## Properties Name | Type | Description | Notes diff --git a/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md new file mode 100644 index 000000000..37526f4d9 --- /dev/null +++ b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard.md @@ -0,0 +1,12 @@ +# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**last4** | **string** | The new last 4 digits of the card number associated to the Tokenized Card. | [optional] +**expirationMonth** | **string** | The new two-digit month of the card associated to the Tokenized Card. Format: `MM`. Possible Values: `01` through `12`. | [optional] +**expirationYear** | **string** | The new four-digit year of the card associated to the Tokenized Card. Format: `YYYY`. | [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) + + diff --git a/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md new file mode 100644 index 000000000..1f34d57b4 --- /dev/null +++ b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.md @@ -0,0 +1,10 @@ +# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cardArt** | [**\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.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) + + diff --git a/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md new file mode 100644 index 000000000..670c423dc --- /dev/null +++ b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.md @@ -0,0 +1,10 @@ +# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**combinedAsset** | [**\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset**](Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.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) + + diff --git a/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md new file mode 100644 index 000000000..eb577526a --- /dev/null +++ b/docs/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.md @@ -0,0 +1,10 @@ +# Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**update** | **string** | Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card. | [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) + + diff --git a/docs/Model/UpdateSubscription.md b/docs/Model/UpdateSubscription.md index 1769abafa..9059b2b92 100644 --- a/docs/Model/UpdateSubscription.md +++ b/docs/Model/UpdateSubscription.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation**](Rbsv1subscriptionsClientReferenceInformation.md) | | [optional] +**clientReferenceInformation** | [**\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation**](GetAllSubscriptionsResponseClientReferenceInformation.md) | | [optional] **processingInformation** | [**\CyberSource\Model\Rbsv1subscriptionsProcessingInformation**](Rbsv1subscriptionsProcessingInformation.md) | | [optional] **planInformation** | [**\CyberSource\Model\Rbsv1subscriptionsidPlanInformation**](Rbsv1subscriptionsidPlanInformation.md) | | [optional] **subscriptionInformation** | [**\CyberSource\Model\Rbsv1subscriptionsidSubscriptionInformation**](Rbsv1subscriptionsidSubscriptionInformation.md) | | [optional] diff --git a/docs/Model/Upv1capturecontextsData.md b/docs/Model/Upv1capturecontextsData.md index e78e7d594..00926bc62 100644 --- a/docs/Model/Upv1capturecontextsData.md +++ b/docs/Model/Upv1capturecontextsData.md @@ -11,6 +11,8 @@ Name | Type | Description | Notes **processingInformation** | [**\CyberSource\Model\Upv1capturecontextsDataProcessingInformation**](Upv1capturecontextsDataProcessingInformation.md) | | [optional] **recipientInformation** | [**\CyberSource\Model\Upv1capturecontextsDataRecipientInformation**](Upv1capturecontextsDataRecipientInformation.md) | | [optional] **merchantDefinedInformation** | [**\CyberSource\Model\Upv1capturecontextsDataMerchantDefinedInformation**](Upv1capturecontextsDataMerchantDefinedInformation.md) | | [optional] +**deviceInformation** | [**\CyberSource\Model\Upv1capturecontextsDataDeviceInformation**](Upv1capturecontextsDataDeviceInformation.md) | | [optional] +**paymentInformation** | [**\CyberSource\Model\Upv1capturecontextsDataPaymentInformation**](Upv1capturecontextsDataPaymentInformation.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) diff --git a/docs/Model/Upv1capturecontextsDataBuyerInformation.md b/docs/Model/Upv1capturecontextsDataBuyerInformation.md index 7d674d09e..9fba061d0 100644 --- a/docs/Model/Upv1capturecontextsDataBuyerInformation.md +++ b/docs/Model/Upv1capturecontextsDataBuyerInformation.md @@ -4,8 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **personalIdentification** | [**\CyberSource\Model\Upv1capturecontextsDataBuyerInformationPersonalIdentification**](Upv1capturecontextsDataBuyerInformationPersonalIdentification.md) | | [optional] -**merchantCustomerId** | **string** | | [optional] -**companyTaxId** | **string** | | [optional] +**merchantCustomerId** | **string** | The Merchant Customer ID | [optional] +**companyTaxId** | **string** | The Company Tax ID | [optional] +**dateOfBirth** | **string** | The date of birth | [optional] +**language** | **string** | The preferred language | [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) diff --git a/docs/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md b/docs/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md index 6ee6864cd..e346e11b5 100644 --- a/docs/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md +++ b/docs/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cpf** | **string** | | [optional] +**cpf** | **string** | CPF Number (Brazil). Must be 11 digits in length. | [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) diff --git a/docs/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.md b/docs/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.md index f3e90065c..7341c3b45 100644 --- a/docs/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.md +++ b/docs/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**challengeCode** | **string** | | [optional] -**messageCategory** | **string** | | [optional] +**challengeCode** | **string** | The challenge code | [optional] +**messageCategory** | **string** | The message category | [optional] +**acsWindowSize** | **string** | The acs window size | [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) diff --git a/docs/Model/Upv1capturecontextsDataDeviceInformation.md b/docs/Model/Upv1capturecontextsDataDeviceInformation.md new file mode 100644 index 000000000..765b8f7c5 --- /dev/null +++ b/docs/Model/Upv1capturecontextsDataDeviceInformation.md @@ -0,0 +1,10 @@ +# Upv1capturecontextsDataDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ipAddress** | **string** | The IP Address | [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) + + diff --git a/docs/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md b/docs/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md index baf6ea04b..368ba806d 100644 --- a/docs/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md +++ b/docs/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.md @@ -4,6 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | The name of the merchant | [optional] +**alternateName** | **string** | The alternate name of the merchant | [optional] +**locality** | **string** | The locality of the merchant | [optional] +**phone** | **string** | The phone number of the merchant | [optional] +**country** | **string** | The country code of the merchant | [optional] +**postalCode** | **string** | The postal code of the merchant | [optional] +**administrativeArea** | **string** | The administrative area of the merchant | [optional] +**address1** | **string** | The first line of the merchant's address | [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) diff --git a/docs/Model/Upv1capturecontextsDataOrderInformation.md b/docs/Model/Upv1capturecontextsDataOrderInformation.md index f826a97d9..89e306ea2 100644 --- a/docs/Model/Upv1capturecontextsDataOrderInformation.md +++ b/docs/Model/Upv1capturecontextsDataOrderInformation.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **billTo** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationBillTo**](Upv1capturecontextsDataOrderInformationBillTo.md) | | [optional] **shipTo** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationShipTo**](Upv1capturecontextsDataOrderInformationShipTo.md) | | [optional] **lineItems** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationLineItems**](Upv1capturecontextsDataOrderInformationLineItems.md) | | [optional] +**invoiceDetails** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationInvoiceDetails**](Upv1capturecontextsDataOrderInformationInvoiceDetails.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) diff --git a/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetails.md b/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetails.md index 883d34b27..151050034 100644 --- a/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetails.md +++ b/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetails.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **subTotalAmount** | **string** | This field defines the sub total amount applicable to the order. | [optional] **serviceFeeAmount** | **string** | This field defines the service fee amount applicable to the order. | [optional] **taxAmount** | **string** | This field defines the tax amount applicable to the order. | [optional] +**taxDetails** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails**](Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.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) diff --git a/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.md b/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.md new file mode 100644 index 000000000..031ab3eac --- /dev/null +++ b/docs/Model/Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.md @@ -0,0 +1,11 @@ +# Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**taxId** | **string** | This field defines the tax identifier/registration number | [optional] +**type** | **string** | This field defines the Tax type code (N=National, S=State, L=Local etc) | [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) + + diff --git a/docs/Model/Upv1capturecontextsDataOrderInformationInvoiceDetails.md b/docs/Model/Upv1capturecontextsDataOrderInformationInvoiceDetails.md new file mode 100644 index 000000000..b6d3e09c9 --- /dev/null +++ b/docs/Model/Upv1capturecontextsDataOrderInformationInvoiceDetails.md @@ -0,0 +1,11 @@ +# Upv1capturecontextsDataOrderInformationInvoiceDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invoiceNumber** | **string** | Invoice number | [optional] +**productDescription** | **string** | Product description | [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) + + diff --git a/docs/Model/Upv1capturecontextsDataOrderInformationLineItems.md b/docs/Model/Upv1capturecontextsDataOrderInformationLineItems.md index 570cfb69a..b6a96cff2 100644 --- a/docs/Model/Upv1capturecontextsDataOrderInformationLineItems.md +++ b/docs/Model/Upv1capturecontextsDataOrderInformationLineItems.md @@ -3,37 +3,37 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productCode** | **string** | | [optional] -**productName** | **string** | | [optional] -**productSku** | **string** | | [optional] -**quantity** | **int** | | [optional] -**unitPrice** | **string** | | [optional] -**unitOfMeasure** | **string** | | [optional] -**totalAmount** | **string** | | [optional] -**taxAmount** | **string** | | [optional] -**taxRate** | **string** | | [optional] -**taxAppliedAfterDiscount** | **string** | | [optional] -**taxStatusIndicator** | **string** | | [optional] -**taxTypeCode** | **string** | | [optional] -**amountIncludesTax** | **bool** | | [optional] -**typeOfSupply** | **string** | | [optional] -**commodityCode** | **string** | | [optional] -**discountAmount** | **string** | | [optional] -**discountApplied** | **bool** | | [optional] -**discountRate** | **string** | | [optional] -**invoiceNumber** | **string** | | [optional] +**productCode** | **string** | Code identifying the product. | [optional] +**productName** | **string** | Name of the product. | [optional] +**productSku** | **string** | Stock Keeping Unit identifier | [optional] +**quantity** | **int** | Quantity of the product | [optional] +**unitPrice** | **string** | Price per unit | [optional] +**unitOfMeasure** | **string** | Unit of measure (e.g. EA, KG, LB) | [optional] +**totalAmount** | **string** | Total amount for the line item | [optional] +**taxAmount** | **string** | Tax amount applied | [optional] +**taxRate** | **string** | Tax rate applied | [optional] +**taxAppliedAfterDiscount** | **string** | Indicates if tax applied after discount | [optional] +**taxStatusIndicator** | **string** | Tax status indicator | [optional] +**taxTypeCode** | **string** | Tax type code | [optional] +**amountIncludesTax** | **bool** | Indicates if amount includes tax | [optional] +**typeOfSupply** | **string** | Type of supply | [optional] +**commodityCode** | **string** | Commodity code | [optional] +**discountAmount** | **string** | Discount amount applied | [optional] +**discountApplied** | **bool** | Indicates if discount applied | [optional] +**discountRate** | **string** | Discount rate applied | [optional] +**invoiceNumber** | **string** | Invoice number for the line item | [optional] **taxDetails** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationLineItemsTaxDetails**](Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md) | | [optional] -**fulfillmentType** | **string** | | [optional] -**weight** | **string** | | [optional] -**weightIdentifier** | **string** | | [optional] -**weightUnit** | **string** | | [optional] -**referenceDataCode** | **string** | | [optional] -**referenceDataNumber** | **string** | | [optional] -**unitTaxAmount** | **string** | | [optional] -**productDescription** | **string** | | [optional] -**giftCardCurrency** | **string** | | [optional] -**shippingDestinationTypes** | **string** | | [optional] -**gift** | **bool** | | [optional] +**fulfillmentType** | **string** | Fulfillment type | [optional] +**weight** | **string** | Weight of the product | [optional] +**weightIdentifier** | **string** | Weight identifier | [optional] +**weightUnit** | **string** | Unit of weight of the product | [optional] +**referenceDataCode** | **string** | Reference data code | [optional] +**referenceDataNumber** | **string** | Reference data number | [optional] +**unitTaxAmount** | **string** | Unit tax amount | [optional] +**productDescription** | **string** | Description of the product | [optional] +**giftCardCurrency** | **string** | Gift card currency | [optional] +**shippingDestinationTypes** | **string** | Shipping destination types | [optional] +**gift** | **bool** | Indicates if item is a gift | [optional] **passenger** | [**\CyberSource\Model\Upv1capturecontextsDataOrderInformationLineItemsPassenger**](Upv1capturecontextsDataOrderInformationLineItemsPassenger.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) diff --git a/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md b/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md index 4d01587d1..f13bb1acf 100644 --- a/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md +++ b/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **string** | | [optional] -**status** | **string** | | [optional] -**phone** | **string** | | [optional] -**firstName** | **string** | | [optional] -**lastName** | **string** | | [optional] -**id** | **string** | | [optional] -**email** | **string** | | [optional] -**nationality** | **string** | | [optional] +**type** | **string** | Passenger type | [optional] +**status** | **string** | Passenger status | [optional] +**phone** | **string** | Passenger phone number | [optional] +**firstName** | **string** | Passenger first name | [optional] +**lastName** | **string** | Passenger last name | [optional] +**id** | **string** | Passenger ID | [optional] +**email** | **string** | Passenger email | [optional] +**nationality** | **string** | Passenger nationality | [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) diff --git a/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md b/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md index b85afdf20..08adb7235 100644 --- a/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md +++ b/docs/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **string** | | [optional] -**amount** | **string** | | [optional] -**rate** | **string** | | [optional] -**code** | **string** | | [optional] -**taxId** | **string** | | [optional] -**applied** | **bool** | | [optional] -**exemptionCode** | **string** | | [optional] +**type** | **string** | Type of tax | [optional] +**amount** | **string** | Tax amount | [optional] +**rate** | **string** | Tax rate | [optional] +**code** | **string** | Tax code | [optional] +**taxId** | **string** | Tax Identifier | [optional] +**applied** | **bool** | Indicates if tax applied | [optional] +**exemptionCode** | **string** | Tax exemption code | [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) diff --git a/docs/Model/Upv1capturecontextsDataPaymentInformation.md b/docs/Model/Upv1capturecontextsDataPaymentInformation.md new file mode 100644 index 000000000..8cbab6f00 --- /dev/null +++ b/docs/Model/Upv1capturecontextsDataPaymentInformation.md @@ -0,0 +1,10 @@ +# Upv1capturecontextsDataPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**\CyberSource\Model\Upv1capturecontextsDataPaymentInformationCard**](Upv1capturecontextsDataPaymentInformationCard.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) + + diff --git a/docs/Model/Upv1capturecontextsDataPaymentInformationCard.md b/docs/Model/Upv1capturecontextsDataPaymentInformationCard.md new file mode 100644 index 000000000..68b6216d2 --- /dev/null +++ b/docs/Model/Upv1capturecontextsDataPaymentInformationCard.md @@ -0,0 +1,10 @@ +# Upv1capturecontextsDataPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**typeSelectionIndicator** | **string** | The card type selection indicator | [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) + + diff --git a/docs/Model/Upv1capturecontextsDataProcessingInformation.md b/docs/Model/Upv1capturecontextsDataProcessingInformation.md index 282fe46d6..848a3fee8 100644 --- a/docs/Model/Upv1capturecontextsDataProcessingInformation.md +++ b/docs/Model/Upv1capturecontextsDataProcessingInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reconciliationId** | **string** | | [optional] +**reconciliationId** | **string** | The reconciliation ID | [optional] **authorizationOptions** | [**\CyberSource\Model\Upv1capturecontextsDataProcessingInformationAuthorizationOptions**](Upv1capturecontextsDataProcessingInformationAuthorizationOptions.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) diff --git a/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md b/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md index 9903c9dfc..21be2a790 100644 --- a/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md +++ b/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.md @@ -3,9 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**aftIndicator** | **bool** | | [optional] +**aftIndicator** | **bool** | The AFT indicator | [optional] +**authIndicator** | **string** | The authorization indicator | [optional] +**ignoreCvResult** | **bool** | Ignore the CV result | [optional] +**ignoreAvsResult** | **bool** | Ignore the AVS result | [optional] **initiator** | [**\CyberSource\Model\Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator**](Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] -**businessApplicationId** | **string** | | [optional] +**businessApplicationId** | **string** | The business application Id | [optional] +**commerceIndicator** | **string** | The commerce indicator | [optional] +**processingInstruction** | **string** | The processing instruction | [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) diff --git a/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md b/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md index 4e91eeba6..9b2b7e0c9 100644 --- a/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md +++ b/docs/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**credentialStoredOnFile** | **bool** | | [optional] +**credentialStoredOnFile** | **bool** | Store the credential on file | [optional] **merchantInitiatedTransaction** | [**\CyberSource\Model\Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.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) diff --git a/docs/Model/Upv1capturecontextsDataRecipientInformation.md b/docs/Model/Upv1capturecontextsDataRecipientInformation.md index 8887b7950..917c57c2e 100644 --- a/docs/Model/Upv1capturecontextsDataRecipientInformation.md +++ b/docs/Model/Upv1capturecontextsDataRecipientInformation.md @@ -10,6 +10,8 @@ Name | Type | Description | Notes **accountId** | **string** | The account ID of the recipient | [optional] **administrativeArea** | **string** | The administrative area of the recipient | [optional] **accountType** | **string** | The account type of the recipient | [optional] +**dateOfBirth** | **string** | The date of birth of the recipient | [optional] +**postalCode** | **string** | The postal code of the recipient | [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) diff --git a/generator/cybersource-rest-spec-php.json b/generator/cybersource-rest-spec-php.json index 9db4d9e02..b974731bb 100644 --- a/generator/cybersource-rest-spec-php.json +++ b/generator/cybersource-rest-spec-php.json @@ -65,6 +65,10 @@ "name": "payment-tokens", "description": "A payment-tokens is a service that is used for retrieving vault details or deleting vault id/payment method.\n" }, + { + "name": "Tokenize", + "description": "An orchestration resource used to combine multiple API calls into a single request.\n" + }, { "name": "Customer", "description": "A Customer can be linked to multiple Payment Instruments and Shipping Addresses.\nWith one Payment Instrument and Shipping Address designated as the default.\nIt stores merchant reference information for the Customer such as email and merchant defined data.\n" @@ -85,6 +89,10 @@ "name": "Instrument Identifier", "description": "An Instrument Identifier represents a unique card number(PAN) or bank account (echeck).\nIt can also be associated with a Network Token that can be used for payment transactions.\n" }, + { + "name": "Tokenized Card", + "description": "A Tokenized Card represents a Network Token that can be used for payment transactions.\n" + }, { "name": "Token", "description": "Token resources can act on different token types such as Customers, Payment Instruments or Instrument Identifiers.\n" @@ -3135,6 +3143,11 @@ "type": "string", "maxLength": 10, "description": "Acquirer country." + }, + "serviceProvidername": { + "type": "string", + "maxLength": 50, + "description": "Contains transfer service provider name." } } }, @@ -47498,10 +47511,10 @@ } } }, - "/tms/v2/customers": { + "/tms/v2/tokenize": { "post": { - "summary": "Create a Customer", - "description": "| | | |\n| --- | --- | --- |\n|**Customers**
A Customer represents your tokenized customer information.
You should associate the Customer Id with the customer account on your systems.
A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.

**Creating a Customer**
It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
The Customer will be created with a Payment Instrument and Shipping Address.
You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).
For more information about Payment Network Tokens see the Developer Guide.

**Payments with Customers**
To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).
To perform a payment with a particular Payment Instrument or Shipping Address
specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).\nThe availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.\n", + "summary": "Tokenize", + "description": "| | | | \n| --- | --- | --- |\n|The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **\"TOKEN_CREATE\"** and the types of tokens to be created. The **tokenInformation** section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|      |The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.
In cases where token creation encounters issues, the response includes a **non-2XX** status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.\n", "parameters": [ { "name": "profile-id", @@ -47514,154 +47527,53 @@ "x-hide-field": true }, { - "name": "postCustomerRequest", + "name": "postTokenizeRequest", "in": "body", "required": true, "schema": { "type": "object", "properties": { - "_links": { + "processingInformation": { "type": "object", - "readOnly": true, "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Customer.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" - } - } - }, - "paymentInstruments": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Customers Payment Instruments.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" - } - } + "actionList": { + "type": "array", + "description": "Array of actions (one or more) to be included in the tokenize request.\n\nPossible Values:\n\n - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your tokenize request.\n", + "items": { + "type": "string" + }, + "example": [ + "TOKEN_CREATE" + ] }, - "shippingAddress": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Customers Shipping Addresses.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses" - } - } + "actionTokenTypes": { + "type": "array", + "description": "TMS tokens types you want to perform the action on.\n\nPossible Values:\n- customer\n- paymentInstrument\n- instrumentIdentifier\n- shippingAddress\n- tokenizedCard\n", + "items": { + "type": "string" + }, + "example": [ + "customer", + "paymentInstrument", + "shippingAddress", + "instrumentIdentifier" + ] } } }, - "id": { - "type": "string", - "minLength": 1, - "maxLength": 32, - "description": "The Id of the Customer Token." - }, - "objectInformation": { + "tokenInformation": { "type": "object", "properties": { - "title": { + "jti": { "type": "string", - "description": "Name or title of the customer.\n", - "maxLength": 60 + "maxLength": 64, + "description": "TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV).\n" }, - "comment": { - "type": "string", - "description": "Comments that you can make about the customer.\n", - "maxLength": 150 - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerID": { + "transientTokenJwt": { "type": "string", - "description": "Your identifier for the customer.\n", - "maxLength": 100 + "description": "Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result.\n" }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's primary email address, including the full domain name.\n" - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Client-generated order reference or tracking number.\n", - "maxLength": 50 - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "Object containing the custom data that the merchant defines.\n", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4\n\nFor example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2\nPossible Values:\n- data1\n- data2\n- data3\n- data4\n- sensitive1\n- sensitive2\n- sensitive3\n- sensitive4\n" - }, - "value": { - "type": "string", - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n", - "maxLength": 100 - } - } - } - }, - "defaultPaymentInstrument": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Id of the Customers default Payment Instrument\n" - } - } - }, - "defaultShippingAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Id of the Customers default Shipping Address\n" - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "readOnly": true, - "description": "The creator of the Customer.\n" - } - } - }, - "_embedded": { - "type": "object", - "readOnly": true, - "description": "Additional resources for the Customer.\n", - "properties": { - "defaultPaymentInstrument": { - "readOnly": true, + "customer": { "type": "object", "properties": { "_links": { @@ -47675,20 +47587,32 @@ "href": { "type": "string", "readOnly": true, - "description": "Link to the Payment Instrument.\n", + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Payment Instruments.\n", "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" } } }, - "customer": { + "shippingAddress": { "type": "object", "readOnly": true, "properties": { "href": { "type": "string", "readOnly": true, - "description": "Link to the Customer.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + "description": "Link to the Customers Shipping Addresses.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses" } } } @@ -47698,251 +47622,81 @@ "type": "string", "minLength": 1, "maxLength": 32, - "description": "The Id of the Payment Instrument Token." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "paymentInstrument", - "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + "description": "The Id of the Customer Token." }, - "default": { - "type": "boolean", - "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 18, - "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" - } - } - }, - "card": { + "objectInformation": { "type": "object", "properties": { - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" - }, - "type": { - "type": "string", - "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 2, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { + "title": { "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + "description": "Name or title of the customer.\n", + "maxLength": 60 }, - "useAs": { + "comment": { "type": "string", - "example": "pinless debit", - "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" - }, - "hash": { - "type": "string", - "minLength": 32, - "maxLength": 34, - "readOnly": true, - "description": "Hash value representing the card.\n" - }, - "tokenizedInformation": { - "type": "object", - "properties": { - "requestorID": { - "type": "string", - "maxLength": 11, - "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" - }, - "transactionType": { - "type": "string", - "maxLength": 1, - "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" - } - } + "description": "Comments that you can make about the customer.\n", + "maxLength": 150 } } }, "buyerInformation": { "type": "object", "properties": { - "companyTaxID": { - "type": "string", - "maxLength": 9, - "description": "Company's tax identifier. This is only used for eCheck service.\n" - }, - "currency": { + "merchantCustomerID": { "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your identifier for the customer.\n", + "maxLength": 100 }, - "dateOfBirth": { + "email": { "type": "string", - "format": "date", - "example": "1960-12-30", - "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "The value of the identification type.\n" - }, - "type": { - "type": "string", - "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", - "maxLength": 20 - } - } - } - } - } + "maxLength": 255, + "description": "Customer's primary email address, including the full domain name.\n" } } }, - "billTo": { + "clientReferenceInformation": { "type": "object", "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer's first name. This name must be the same as the name on the card.\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer's last name. This name must be the same as the name on the card.\n" - }, - "company": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer's company.\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "Payment card billing city.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 20, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" - }, - "country": { + "code": { "type": "string", - "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer's phone number.\n" + "description": "Client-generated order reference or tracking number.\n", + "maxLength": 50 } } }, - "processingInformation": { - "type": "object", - "title": "tmsPaymentInstrumentProcessingInfo", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" - } + "merchantDefinedInformation": { + "type": "array", + "description": "Object containing the custom data that the merchant defines.\n", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4\n\nFor example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2\nPossible Values:\n- data1\n- data2\n- data3\n- data4\n- sensitive1\n- sensitive2\n- sensitive3\n- sensitive4\n" + }, + "value": { + "type": "string", + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n", + "maxLength": 100 } } } }, - "merchantInformation": { + "defaultPaymentInstrument": { "type": "object", "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", - "maxLength": 13 - } - } + "id": { + "type": "string", + "description": "The Id of the Customers default Payment Instrument\n" } } }, - "instrumentIdentifier": { + "defaultShippingAddress": { "type": "object", "properties": { "id": { "type": "string", - "minLength": 12, - "maxLength": 32, - "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + "description": "The Id of the Customers default Shipping Address\n" } } }, @@ -47953,18 +47707,17 @@ "creator": { "type": "string", "readOnly": true, - "description": "The creator of the Payment Instrument.\n" + "description": "The creator of the Customer.\n" } } }, "_embedded": { "type": "object", "readOnly": true, - "description": "Additional resources for the Payment Instrument.\n", + "description": "Additional resources for the Customer.\n", "properties": { - "instrumentIdentifier": { + "defaultPaymentInstrument": { "readOnly": true, - "title": "tmsEmbeddedInstrumentIdentifier", "type": "object", "properties": { "_links": { @@ -47978,20 +47731,20 @@ "href": { "type": "string", "readOnly": true, - "description": "Link to the Instrument Identifier.\n", - "example": "tms/v1/instrumentidentifiers/7010000000016241111" + "description": "Link to the Payment Instrument.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" } } }, - "paymentInstruments": { + "customer": { "type": "object", "readOnly": true, "properties": { "href": { "type": "string", "readOnly": true, - "description": "Link to the Instrument Identifiers Payment Instruments.\n", - "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" } } } @@ -47999,13 +47752,19 @@ }, "id": { "type": "string", - "description": "The Id of the Instrument Identifier Token.\n" + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Payment Instrument Token." }, "object": { "type": "string", "readOnly": true, - "example": "instrumentIdentifier", - "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + "example": "paymentInstrument", + "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" }, "state": { "type": "string", @@ -48015,35 +47774,22 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" - }, - "source": { - "type": "string", - "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + "readOnly": true, + "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" }, - "tokenProvisioningInformation": { + "bankAccount": { "type": "object", "properties": { - "consumerConsentObtained": { - "type": "boolean", - "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" - }, - "multiFactorAuthenticated": { - "type": "boolean", - "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + "type": { + "type": "string", + "maxLength": 18, + "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" } } }, "card": { "type": "object", - "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", "properties": { - "number": { - "type": "string", - "minLength": 12, - "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" - }, "expirationMonth": { "type": "string", "maxLength": 2, @@ -48054,474 +47800,94 @@ "maxLength": 4, "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" }, - "securityCode": { - "type": "string", - "maxLength": 4, - "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "required": [ - "emvTags" - ], - "properties": { - "emvTags": { - "type": "array", - "minItems": 1, - "maxItems": 50, - "items": { - "type": "object", - "required": [ - "tag", - "value", - "source" - ], - "properties": { - "tag": { - "type": "string", - "minLength": 1, - "maxLength": 10, - "pattern": "^[0-9A-Fa-f]{1,10}$", - "description": "EMV tag, 1-10 hex characters." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 64, - "description": "EMV tag value, 1-64 characters." - }, - "source": { - "type": "string", - "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" - } - }, - "example": { - "tag": "5A", - "value": "4111111111111111", - "source": "CARD" - } - } - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 17, - "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" - }, - "routingNumber": { - "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" - } - } - }, - "tokenizedCard": { - "title": "tmsv2TokenizedCard", - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "description": "The Id of the Tokenized Card.\n" - }, - "object": { - "type": "string", - "readOnly": true, - "example": "tokenizedCard", - "description": "The type.\nPossible Values:\n- tokenizedCard\n" - }, - "accountReferenceId": { - "type": "string", - "description": "An identifier provided by the issuer for the account.\n" - }, - "consumerId": { - "type": "string", - "maxLength": 36, - "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." - }, - "createInstrumentIdentifier": { - "type": "boolean", - "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" - }, - "source": { - "type": "string", - "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" - }, - "reason": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" - }, - "number": { - "type": "string", - "readOnly": true, - "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" - }, - "expirationMonth": { - "type": "string", - "readOnly": true, - "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "readOnly": true, - "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" - }, "type": { "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" }, - "cryptogram": { + "issueNumber": { "type": "string", - "readOnly": true, - "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", - "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" - }, - "securityCode": { - "type": "string", - "readOnly": true, - "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", - "example": "4523" - }, - "eci": { - "type": "string", - "readOnly": true, - "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" }, - "requestorId": { + "startMonth": { "type": "string", - "readOnly": true, - "maxLength": 11, - "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" }, - "enrollmentId": { + "startYear": { "type": "string", - "readOnly": true, - "description": "Unique id to identify this PAN/ enrollment.\n" + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" }, - "tokenReferenceId": { + "useAs": { "type": "string", - "readOnly": true, - "description": "Unique ID for netwrok token.\n" + "example": "pinless debit", + "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" }, - "paymentAccountReference": { + "hash": { "type": "string", + "minLength": 32, + "maxLength": 34, "readOnly": true, - "description": "Payment account reference.\n" + "description": "Hash value representing the card.\n" }, - "card": { + "tokenizedInformation": { "type": "object", - "description": "Card object used to create a network token\n", "properties": { - "number": { - "type": "string", - "minLength": 12, - "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" - }, - "type": { + "requestorID": { "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" }, - "suffix": { + "transactionType": { "type": "string", - "readOnly": true, - "description": "The customer's latest payment card number suffix.\n" - }, - "issueDate": { - "type": "string", - "readOnly": true, - "format": "date", - "description": "Card issuance date. XML date format: YYYY-MM-DD.", - "example": "2030-12-15" - }, - "activationDate": { - "type": "string", - "readOnly": true, - "format": "date", - "description": "Card activation date. XML date format: YYYY-MM-DD", - "example": "2030-12-20" - }, - "expirationPrinted": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if the expiration date is printed on the card.", - "example": true - }, - "securityCodePrinted": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if the Card Verification Number is printed on the card.", - "example": true - }, - "termsAndConditions": { - "type": "object", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "readOnly": true, - "description": "Issuer Card Terms and Conditions url." - } - } - } - } - }, - "passcode": { - "type": "object", - "description": "Passcode by issuer for ID&V.\n", - "properties": { - "value": { - "type": "string", - "description": "OTP generated at issuer.\n" - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "description": "Metadata associated with the tokenized card.\n", - "properties": { - "cardArt": { - "title": "TmsCardArt", - "description": "Card art associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "foregroundColor": { - "description": "Card foreground color.\n", - "type": "string", - "readOnly": true - }, - "combinedAsset": { - "description": "Combined card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" - } - } - } - } - } - } - }, - "brandLogoAsset": { - "description": "Brand logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" - } - } - } - } - } - } - }, - "issuerLogoAsset": { - "description": "Issuer logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" - } - } - } - } - } - } - }, - "iconAsset": { - "description": "Icon card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" - } - } - } - } - } - } - } - } - }, - "issuer": { - "description": "Issuer associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "name": { - "description": "Issuer name.\n", - "type": "string", - "readOnly": true - }, - "shortDescription": { - "description": "Short description of the card.\n", - "type": "string", - "readOnly": true - }, - "longDescription": { - "description": "Long description of the card.\n", - "type": "string", - "readOnly": true - }, - "email": { - "type": "string", - "readOnly": true, - "description": "Issuer customer service email address." - }, - "phoneNumber": { - "type": "string", - "readOnly": true, - "description": "Issuer customer service phone number." - }, - "url": { - "type": "string", - "readOnly": true, - "description": "Issuer customer service url." - } - } + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" } } } } }, - "issuer": { + "buyerInformation": { "type": "object", - "readOnly": true, "properties": { - "paymentAccountReference": { + "companyTaxID": { "type": "string", - "readOnly": true, - "maxLength": 32, - "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "title": "tmsAuthorizationOptions", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "maxLength": 15, - "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" - }, - "originalAuthorizedAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount of the original authorization.\n" - } + "maxLength": 9, + "description": "Company's tax identifier. This is only used for eCheck service.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "dateOfBirth": { + "type": "string", + "format": "date", + "example": "1960-12-30", + "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type.\n" + }, + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", + "maxLength": 20 } } } @@ -48532,7 +47898,4760 @@ }, "billTo": { "type": "object", - "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer's company.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer's phone number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "title": "tmsPaymentInstrumentProcessingInfo", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "title": "TmsMerchantInformation", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", + "maxLength": 13 + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "minLength": 12, + "maxLength": 32, + "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Payment Instrument.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Payment Instrument.\n", + "properties": { + "instrumentIdentifier": { + "readOnly": true, + "title": "tmsEmbeddedInstrumentIdentifier", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Instrument Identifier." + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "properties": { + "binLookup": { + "title": "TmsBinLookup", + "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n", + "readOnly": true, + "type": "object", + "properties": { + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n" + }, + "sharedBIN": { + "type": "boolean", + "description": "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n" + }, + "posDomesticOnly": { + "type": "boolean", + "description": "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n" + }, + "gamblingAllowed": { + "type": "boolean", + "description": "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel2": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel3": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "exemptBIN": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n" + }, + "accountLevelManagement": { + "type": "boolean", + "description": "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n" + }, + "onlineGamblingBlock": { + "type": "boolean", + "description": "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "autoSubstantiation": { + "type": "boolean", + "description": "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "flexCredential": { + "type": "boolean", + "description": "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n" + }, + "productId": { + "type": "string", + "description": "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n" + }, + "productIdSubtype": { + "type": "string", + "description": "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n" + }, + "threeDSSupport": { + "type": "boolean", + "description": "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n" + }, + "siEligible": { + "type": "boolean", + "description": "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n" + }, + "emiEligible": { + "type": "boolean", + "description": "This field indicates if the card is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "defaultShippingAddress": { + "readOnly": true, + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Shipping Address\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses/D9F3439F0448C901E053A2598D0AA1CC" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Shipping Address Token." + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer shipping address is the dafault.\nPossible Values:\n - `true`: Shipping Address is customer's default.\n - `false`: Shipping Address is not customer's default.\n" + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Company associated with the shipping address.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the shipping address. Use 2 character the State,\nProvince, and Territory Codes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.\n", + "maxLength": 2 + }, + "email": { + "type": "string", + "maxLength": 320, + "description": "Email associated with the shipping address.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Shipping Address." + } + } + } + } + } + } + } + } + }, + "shippingAddress": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Shipping Address\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses/D9F3439F0448C901E053A2598D0AA1CC" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Shipping Address Token." + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer shipping address is the dafault.\nPossible Values:\n - `true`: Shipping Address is customer's default.\n - `false`: Shipping Address is not customer's default.\n" + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Company associated with the shipping address.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the shipping address. Use 2 character the State,\nProvince, and Territory Codes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.\n", + "maxLength": 2 + }, + "email": { + "type": "string", + "maxLength": 320, + "description": "Email associated with the shipping address.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Shipping Address." + } + } + } + } + }, + "paymentInstrument": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Payment Instrument.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Payment Instrument Token." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "paymentInstrument", + "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 18, + "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" + }, + "hash": { + "type": "string", + "minLength": 32, + "maxLength": 34, + "readOnly": true, + "description": "Hash value representing the card.\n" + }, + "tokenizedInformation": { + "type": "object", + "properties": { + "requestorID": { + "type": "string", + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" + }, + "transactionType": { + "type": "string", + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "maxLength": 9, + "description": "Company's tax identifier. This is only used for eCheck service.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "dateOfBirth": { + "type": "string", + "format": "date", + "example": "1960-12-30", + "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type.\n" + }, + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", + "maxLength": 20 + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer's company.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer's phone number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "title": "tmsPaymentInstrumentProcessingInfo", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "title": "TmsMerchantInformation", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", + "maxLength": 13 + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "minLength": 12, + "maxLength": 32, + "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Payment Instrument.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Payment Instrument.\n", + "properties": { + "instrumentIdentifier": { + "readOnly": true, + "title": "tmsEmbeddedInstrumentIdentifier", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Instrument Identifier." + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "properties": { + "binLookup": { + "title": "TmsBinLookup", + "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n", + "readOnly": true, + "type": "object", + "properties": { + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n" + }, + "sharedBIN": { + "type": "boolean", + "description": "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n" + }, + "posDomesticOnly": { + "type": "boolean", + "description": "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n" + }, + "gamblingAllowed": { + "type": "boolean", + "description": "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel2": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel3": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "exemptBIN": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n" + }, + "accountLevelManagement": { + "type": "boolean", + "description": "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n" + }, + "onlineGamblingBlock": { + "type": "boolean", + "description": "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "autoSubstantiation": { + "type": "boolean", + "description": "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "flexCredential": { + "type": "boolean", + "description": "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n" + }, + "productId": { + "type": "string", + "description": "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n" + }, + "productIdSubtype": { + "type": "string", + "description": "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n" + }, + "threeDSSupport": { + "type": "boolean", + "description": "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n" + }, + "siEligible": { + "type": "boolean", + "description": "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n" + }, + "emiEligible": { + "type": "boolean", + "description": "This field indicates if the card is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Instrument Identifier." + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "properties": { + "binLookup": { + "title": "TmsBinLookup", + "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n", + "readOnly": true, + "type": "object", + "properties": { + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n" + }, + "sharedBIN": { + "type": "boolean", + "description": "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n" + }, + "posDomesticOnly": { + "type": "boolean", + "description": "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n" + }, + "gamblingAllowed": { + "type": "boolean", + "description": "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel2": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel3": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "exemptBIN": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n" + }, + "accountLevelManagement": { + "type": "boolean", + "description": "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n" + }, + "onlineGamblingBlock": { + "type": "boolean", + "description": "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "autoSubstantiation": { + "type": "boolean", + "description": "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "flexCredential": { + "type": "boolean", + "description": "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n" + }, + "productId": { + "type": "string", + "description": "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n" + }, + "productIdSubtype": { + "type": "string", + "description": "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n" + }, + "threeDSSupport": { + "type": "boolean", + "description": "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n" + }, + "siEligible": { + "type": "boolean", + "description": "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n" + }, + "emiEligible": { + "type": "boolean", + "description": "This field indicates if the card is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + ], + "tags": [ + "Tokenize" + ], + "operationId": "tokenize", + "x-devcenter-metaData": { + "categoryTag": "Token_Management", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/all/rest/tms-developer/intro.html", + "mleForRequest": "mandatory" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "Returns the responses from the orchestrated API requests.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally-unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "properties": { + "responses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resource": { + "type": "string", + "description": "TMS token type associated with the response.\n\nPossible Values:\n- customer\n- paymentInstrument\n- instrumentIdentifier\n- shippingAddress\n- tokenizedCard\n", + "example": "customer" + }, + "httpStatus": { + "type": "integer", + "format": "int32", + "description": "Http status associated with the response.\n", + "example": 201 + }, + "id": { + "type": "string", + "description": "TMS token id associated with the response.\n", + "example": "351A67733325454AE0633F36CF0A9420" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n - forbidden\n - notFound\n - instrumentIdentifierDeletionError\n - tokenIdConflict\n - conflict\n - notAvailable\n - serverError\n - notAttempted\n\nA \"notAttempted\" error type is returned when the request cannot be processed because it depends on the existence of another token that does not exist. For example, creating a shipping address token is not attempted if the required customer token is missing.\n", + "example": "notAttempted" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type.", + "example": "Creation not attempted due to customer token creation failure" + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error.", + "example": "address1" + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error.", + "example": "billTo" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request: e.g. A required header value could be missing.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error." + } + } + } + } + } + } + } + } + }, + "examples": { + "Invalid Customer request body": { + "errors": [ + { + "type": "invalidRequest", + "message": "Invalid HTTP Body" + } + ] + } + } + }, + "403": { + "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted" + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - notFound\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - internalError\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Create Complete Customer & Network Token using a Card", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "customer", + "shippingAddress", + "paymentInstrument", + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "customer": { + "buyerInformation": { + "merchantCustomerID": "Your customer identifier", + "email": "test@cybs.com" + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "merchantDefinedInformation": [ + { + "name": "data1", + "value": "Your customer data" + } + ] + }, + "shippingAddress": { + "default": "true", + "shipTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "paymentInstrument": { + "default": "true", + "card": { + "expirationMonth": "12", + "expirationYear": "2031", + "type": "001" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" + } + } + } + } + }, + "example1": { + "summary": "Create Customer Payment Instrument & Network Token using a Card", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "paymentInstrument", + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "customer": { + "id": "" + }, + "paymentInstrument": { + "default": "true", + "card": { + "expirationMonth": "12", + "expirationYear": "2031", + "type": "001" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" + } + } + } + } + }, + "example2": { + "summary": "Create Instrument Identifier & Network Token using a Card", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" + } + } + } + } + }, + "example3": { + "summary": "Create Complete Customer using a Transient Token", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "customer", + "shippingAddress", + "paymentInstrument", + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "transientTokenJwt": "", + "customer": { + "buyerInformation": { + "merchantCustomerID": "Your customer identifier", + "email": "test@cybs.com" + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "merchantDefinedInformation": [ + { + "name": "data1", + "value": "Your customer data" + } + ] + }, + "shippingAddress": { + "default": "true", + "shipTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "paymentInstrument": { + "default": "true", + "card": { + "expirationMonth": "12", + "expirationYear": "2031", + "type": "001" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + } + } + } + }, + "example4": { + "summary": "Create Instrument Identifier using a Transient Token", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "transientTokenJwt": "" + } + } + } + } + } + }, + "/tms/v2/customers": { + "post": { + "summary": "Create a Customer", + "description": "| | | |\n| --- | --- | --- |\n|**Customers**
A Customer represents your tokenized customer information.
You should associate the Customer Id with the customer account on your systems.
A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.

**Creating a Customer**
It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
The Customer will be created with a Payment Instrument and Shipping Address.
You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).
For more information about Payment Network Tokens see the Developer Guide.

**Payments with Customers**
To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).
To perform a payment with a particular Payment Instrument or Shipping Address
specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).\nThe availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.\n", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The Id of a profile containing user specific TMS configuration.", + "required": false, + "type": "string", + "minLength": 36, + "maxLength": 36, + "x-hide-field": true + }, + { + "name": "postCustomerRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Payment Instruments.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" + } + } + }, + "shippingAddress": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Shipping Addresses.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Customer Token." + }, + "objectInformation": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Name or title of the customer.\n", + "maxLength": 60 + }, + "comment": { + "type": "string", + "description": "Comments that you can make about the customer.\n", + "maxLength": 150 + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerID": { + "type": "string", + "description": "Your identifier for the customer.\n", + "maxLength": 100 + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's primary email address, including the full domain name.\n" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Client-generated order reference or tracking number.\n", + "maxLength": 50 + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "Object containing the custom data that the merchant defines.\n", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4\n\nFor example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2\nPossible Values:\n- data1\n- data2\n- data3\n- data4\n- sensitive1\n- sensitive2\n- sensitive3\n- sensitive4\n" + }, + "value": { + "type": "string", + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n", + "maxLength": 100 + } + } + } + }, + "defaultPaymentInstrument": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Id of the Customers default Payment Instrument\n" + } + } + }, + "defaultShippingAddress": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Id of the Customers default Shipping Address\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Customer.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Customer.\n", + "properties": { + "defaultPaymentInstrument": { + "readOnly": true, + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Payment Instrument.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Payment Instrument Token." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "paymentInstrument", + "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 18, + "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" + }, + "hash": { + "type": "string", + "minLength": 32, + "maxLength": 34, + "readOnly": true, + "description": "Hash value representing the card.\n" + }, + "tokenizedInformation": { + "type": "object", + "properties": { + "requestorID": { + "type": "string", + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" + }, + "transactionType": { + "type": "string", + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "maxLength": 9, + "description": "Company's tax identifier. This is only used for eCheck service.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "dateOfBirth": { + "type": "string", + "format": "date", + "example": "1960-12-30", + "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type.\n" + }, + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", + "maxLength": 20 + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer's company.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer's phone number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "title": "tmsPaymentInstrumentProcessingInfo", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "title": "TmsMerchantInformation", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", + "maxLength": 13 + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "minLength": 12, + "maxLength": 32, + "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Payment Instrument.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Payment Instrument.\n", + "properties": { + "instrumentIdentifier": { + "readOnly": true, + "title": "tmsEmbeddedInstrumentIdentifier", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", "properties": { "address1": { "type": "string", @@ -48927,7 +53046,8 @@ "operationId": "postCustomer", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -49362,6 +53482,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -51120,6 +55241,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -52875,6 +56997,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -53880,7 +58003,8 @@ "operationId": "patchCustomer", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -54324,6 +58448,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -56255,7 +60380,8 @@ "operationId": "postCustomerShippingAddress", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -58030,7 +62156,8 @@ "operationId": "patchCustomersShippingAddress", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -59303,6 +63430,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -60187,7 +64315,8 @@ "operationId": "postCustomerPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -60491,6 +64620,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -62212,6 +66342,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -63748,6 +67879,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -65247,6 +69379,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -66131,7 +70264,8 @@ "operationId": "patchCustomersPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -66431,6 +70565,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -68473,6 +72608,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -69357,7 +73493,8 @@ "operationId": "postPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -69643,6 +73780,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -71221,6 +75359,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -72718,6 +76857,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -73602,7 +77742,8 @@ "operationId": "patchPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -73902,6 +78043,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -76389,7 +80531,8 @@ "operationId": "postInstrumentIdentifier", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -80528,7 +84671,8 @@ "operationId": "patchInstrumentIdentifier", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -82600,6 +86744,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -84666,7 +88811,8 @@ "operationId": "postInstrumentIdentifierEnrollment", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-partner-ii-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-partner-ii-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -85447,7 +89593,8 @@ "operationId": "postTokenizedCard", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-create-cof-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-create-cof-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -87321,7 +91468,154 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted" + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The Id may not exist or was entered incorrectly.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - notFound\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "409": { + "description": "Conflict. The token is linked to a Payment Instrument.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - instrumentIdentifierDeletionError\n - tokenIdConflict\n - conflict\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "conflict", + "message": "Action cannot be performed as the PaymentInstrument is the customers default" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" }, "message": { "type": "string", @@ -87337,15 +91631,15 @@ "application/json": { "errors": [ { - "type": "forbidden", - "message": "Request not permitted" + "type": "notAvailable", + "message": "Token not available." } ] } } }, - "404": { - "description": "Token Not Found. The Id may not exist or was entered incorrectly.", + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87387,14 +91681,14 @@ "errors": [ { "type": "notFound", - "message": "Token not found" + "message": "Profile not found" } ] } } }, - "409": { - "description": "Conflict. The token is linked to a Payment Instrument.", + "500": { + "description": "Unexpected error.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87405,6 +91699,16 @@ "type": "string" } }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, "schema": { "type": "object", "readOnly": true, @@ -87419,12 +91723,180 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - instrumentIdentifierDeletionError\n - tokenIdConflict\n - conflict\n" + "description": "The type of error.\n\nPossible Values:\n - internalError\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + } + } + } + } + }, + "/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations": { + "post": { + "summary": "Simulate Issuer Life Cycle Management Events", + "description": "**Lifecycle Management Events**
Simulates an issuer life cycle manegement event for updates on the tokenized card.\nThe events that can be simulated are:\n- Token status changes (e.g. active, suspended, deleted)\n- Updates to the underlying card, including card art changes, expiration date changes, and card number suffix.\n**Note:** This is only available in CAS environment.\n", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "required": true, + "type": "string", + "description": "The Id of a profile containing user specific TMS configuration.", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenizedCardId", + "in": "path", + "description": "The Id of a tokenized card.", + "required": true, + "type": "string", + "minLength": 12, + "maxLength": 32 + }, + { + "name": "postIssuerLifeCycleSimulationRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "description": "Represents the Issuer LifeCycle Event Simulation for a Tokenized Card.\n", + "properties": { + "state": { + "type": "string", + "description": "The new state of the Tokenized Card.\nPossible Values:\n- ACTIVE\n- SUSPENDED\n- DELETED\n" + }, + "card": { + "type": "object", + "properties": { + "last4": { + "type": "string", + "maxLength": 4, + "description": "The new last 4 digits of the card number associated to the Tokenized Card.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "The new two-digit month of the card associated to the Tokenized Card.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "The new four-digit year of the card associated to the Tokenized Card.\nFormat: `YYYY`.\n" + } + } + }, + "metadata": { + "type": "object", + "properties": { + "cardArt": { + "type": "object", + "properties": { + "combinedAsset": { + "type": "object", + "properties": { + "update": { + "type": "string", + "description": "Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card.\n" + } + } + } + } + } + } + } + } + } + } + ], + "tags": [ + "Tokenized Card" + ], + "operationId": "postIssuerLifeCycleSimulation", + "x-devcenter-metaData": { + "categoryTag": "Token_Management", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-simulate-issuer-life-cycle-event-intro.html" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "204": { + "description": "The request is fulfilled but does not need to return a body", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + } + }, + "400": { + "description": "Bad Request: e.g. A required header value could be missing.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" }, "message": { "type": "string", "readOnly": true, "description": "The detailed message related to the type." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error." + } + } + } } } } @@ -87432,18 +91904,18 @@ } }, "examples": { - "application/json": { + "Invalid Customer request body": { "errors": [ { - "type": "conflict", - "message": "Action cannot be performed as the PaymentInstrument is the customers default" + "type": "invalidRequest", + "message": "Invalid HTTP Body" } ] } } }, - "410": { - "description": "Token Not Available. The token has been deleted.", + "403": { + "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87468,7 +91940,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -87484,15 +91956,15 @@ "application/json": { "errors": [ { - "type": "notAvailable", - "message": "Token not available." + "type": "forbidden", + "message": "Request not permitted" } ] } } }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "404": { + "description": "Token Not Found. The Id may not exist or was entered incorrectly.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87534,7 +92006,7 @@ "errors": [ { "type": "notFound", - "message": "Profile not found" + "message": "Token not found" } ] } @@ -87589,6 +92061,36 @@ } } } + }, + "x-example": { + "example0": { + "summary": "Simulate Network Token Status Update", + "value": { + "state": "SUSPENDED" + } + }, + "example1": { + "summary": "Simulate Network Token Card Metadata Update", + "value": { + "card": { + "last4": "9876", + "expirationMonth": "11", + "expirationYear": "2040" + } + } + }, + "example2": { + "summary": "Simulate Network Token Card Art Update", + "value": { + "metadata": { + "cardArt": { + "combinedAsset": { + "update": "true" + } + } + } + } + } } } }, @@ -87853,7 +92355,8 @@ "operationId": "postTokenPaymentCredentials", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-partner-retrieve-pay-cred-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-partner-retrieve-pay-cred-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -101675,43 +106178,6 @@ "schema": { "type": "object", "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "comments": { - "type": "string", - "maxLength": 255, - "description": "Brief description of the order or any comment you wish to add to the order.\n" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" - } - } - }, - "applicationName": { - "type": "string", - "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n" - }, - "applicationVersion": { - "type": "string", - "description": "Version of the CyberSource application or integration used for a transaction.\n" - }, - "applicationUser": { - "type": "string", - "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n" - } - } - }, "planInformation": { "type": "object", "required": [ @@ -103422,41 +107888,9 @@ "type": "object", "properties": { "code": { - "description": "> Deprecated: This field is ignored.\n\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", "type": "string", "maxLength": 50 - }, - "comments": { - "description": "> Deprecated: This field is ignored.\n\nBrief description of the order or any comment you wish to add to the order.\n", - "type": "string", - "maxLength": 255 - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - }, - "solutionId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - } - } - }, - "applicationName": { - "description": "> Deprecated: This field is ignored.\n\nThe name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n", - "type": "string" - }, - "applicationVersion": { - "description": "> Deprecated: This field is ignored.\n\nVersion of the CyberSource application or integration used for a transaction.\n", - "type": "string" - }, - "applicationUser": { - "description": "> Deprecated: This field is ignored.\n\nThe entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n", - "type": "string" } } }, @@ -103607,6 +108041,9 @@ "customer": { "id": "C24F5921EB870D99E053AF598E0A4105" } + }, + "clientReferenceInformation": { + "code": "TC501713" } } } @@ -103715,6 +108152,16 @@ "description": "Subscription Status:\n - `PENDING`\n - `ACTIVE`\n - `FAILED`\n" } } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } } }, "example": { @@ -103820,6 +108267,9 @@ "summary": "Create Subscription", "sample-name": "Create Subscription", "value": { + "clientReferenceInformation": { + "code": "TC501713" + }, "subscriptionInformation": { "planId": "6868912495476705603955", "name": "Subscription with PlanId", @@ -103838,13 +108288,7 @@ "sample-name": "(deprecated) Create Subscription with Authorization", "value": { "clientReferenceInformation": { - "code": "TC501713", - "partner": { - "developerId": "ABCD1234", - "solutionId": "GEF1234" - }, - "applicationName": "CYBS-SDK", - "applicationVersion": "v1" + "code": "TC501713" }, "processingInformation": { "commerceIndicator": "recurring", @@ -104116,6 +108560,16 @@ } } }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } + }, "paymentInformation": { "type": "object", "properties": { @@ -104475,18 +108929,28 @@ } } }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } + }, "reactivationInformation": { "type": "object", "properties": { - "skippedPaymentsCount": { + "missedPaymentsCount": { "type": "string", "maxLength": 10, "description": "Number of payments that should have occurred while the subscription was in a suspended status.\n" }, - "skippedPaymentsTotalAmount": { + "missedPaymentsTotalAmount": { "type": "string", "maxLength": 19, - "description": "Total amount that will be charged upon reactivation if `processSkippedPayments` is set to `true`.\n" + "description": "Total amount that will be charged upon reactivation if `processMissedPayments` is set to `true`.\n" } } } @@ -104616,41 +109080,9 @@ "type": "object", "properties": { "code": { - "description": "> Deprecated: This field is ignored.\n\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", "type": "string", "maxLength": 50 - }, - "comments": { - "description": "> Deprecated: This field is ignored.\n\nBrief description of the order or any comment you wish to add to the order.\n", - "type": "string", - "maxLength": 255 - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - }, - "solutionId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - } - } - }, - "applicationName": { - "description": "> Deprecated: This field is ignored.\n\nThe name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n", - "type": "string" - }, - "applicationVersion": { - "description": "> Deprecated: This field is ignored.\n\nVersion of the CyberSource application or integration used for a transaction.\n", - "type": "string" - }, - "applicationUser": { - "description": "> Deprecated: This field is ignored.\n\nThe entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n", - "type": "string" } } }, @@ -105109,7 +109541,7 @@ "/rbs/v1/subscriptions/{id}/suspend": { "post": { "summary": "Suspend a Subscription", - "description": "Suspend a Subscription", + "description": "Suspend a Subscription\n", "tags": [ "Subscriptions" ], @@ -105277,8 +109709,8 @@ }, "/rbs/v1/subscriptions/{id}/activate": { "post": { - "summary": "Activate a Subscription", - "description": "Activate a `SUSPENDED` Subscription\n", + "summary": "Reactivating a Suspended Subscription", + "description": "# Reactivating a Suspended Subscription\n\nYou can reactivate a suspended subscription for the next billing cycle. You cannot reactivate a canceled or completed subscription.\n\nYou can specify whether you want to process missed payments for the period during which the subscription was suspended using the `processMissedPayments` query parameter by setting it to true or false. \nIf no value is specified, the system will default to `true`.\n\n**Important:** The \"processMissedPayments\" query parameter is only effective when the Ask each time before reactivating option is selected in the reactivation settings. If any other option is chosen, the value provided in the request will be ignored by the system. For more information, see the [Recurring Billing User Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/user/all/rest/recurring-billing-user/recurring-billing-user-about-guide.html).\n\nYou can check how many payments were missed and the total amount by retrieving the subscription details, where you will find the `reactivationInformation` object. See: [Retrieving a Subscription](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-dev/recur-bill-subscriptions/recur-bill-getting-a-subscription.html).\n", "tags": [ "Subscriptions" ], @@ -105306,10 +109738,10 @@ "description": "Subscription Id" }, { - "name": "processSkippedPayments", + "name": "processMissedPayments", "in": "query", "type": "boolean", - "description": "Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true.", + "description": "Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true.\nWhen any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored.\n", "required": false, "default": true } @@ -106073,41 +110505,9 @@ "type": "object", "properties": { "code": { - "description": "> Deprecated: This field is ignored.\n\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", "type": "string", "maxLength": 50 - }, - "comments": { - "description": "> Deprecated: This field is ignored.\n\nBrief description of the order or any comment you wish to add to the order.\n", - "type": "string", - "maxLength": 255 - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - }, - "solutionId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - } - } - }, - "applicationName": { - "description": "> Deprecated: This field is ignored.\n\nThe name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n", - "type": "string" - }, - "applicationVersion": { - "description": "> Deprecated: This field is ignored.\n\nVersion of the CyberSource application or integration used for a transaction.\n", - "type": "string" - }, - "applicationUser": { - "description": "> Deprecated: This field is ignored.\n\nThe entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n", - "type": "string" } } }, @@ -106230,13 +110630,7 @@ }, "example": { "clientReferenceInformation": { - "code": "FollowOn from 7216512479796378604957", - "partner": { - "developerId": "ABCD1234", - "solutionId": "GEF1234" - }, - "applicationName": "CYBS-SDK", - "applicationVersion": "v1" + "code": "FollowOn from 7216512479796378604957" }, "processingInformation": { "commerceIndicator": "recurring", @@ -106358,6 +110752,16 @@ "description": "Subscription Status:\n - `PENDING`\n - `ACTIVE`\n - `FAILED`\n" } } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } } }, "example": { @@ -106464,13 +110868,7 @@ "sample-name": "Create Follow-On Subscription", "value": { "clientReferenceInformation": { - "code": "FollowOn from 7216512479796378604957", - "partner": { - "developerId": "ABCD1234", - "solutionId": "GEF1234" - }, - "applicationName": "CYBS-SDK", - "applicationVersion": "v1" + "code": "FollowOn from 7216512479796378604957" }, "processingInformation": { "commerceIndicator": "recurring", @@ -134847,6 +139245,24 @@ } } } + }, + "batchUpload": { + "type": "object", + "properties": { + "subscriptionInformation": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "selfServiceability": { + "type": "string", + "default": "NOT_SELF_SERVICEABLE", + "description": "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY" + } + } + } + } } } }, @@ -136622,26 +141038,159 @@ "type": "string" } } - } - } - }, - "recurringBilling": { - "type": "object", - "properties": { - "subscriptionStatus": { + } + } + }, + "recurringBilling": { + "type": "object", + "properties": { + "subscriptionStatus": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + }, + "configurationStatus": { + "type": "object", + "properties": { + "configurationId": { + "type": "string", + "description": "This is NOT for MVP" + }, + "version": { + "type": "string" + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + } + } + }, + "cybsReadyTerminal": { + "type": "object", + "properties": { + "subscriptionStatus": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + }, + "configurationStatus": { "type": "object", "properties": { + "configurationId": { + "type": "string", + "description": "This is NOT for MVP" + }, + "version": { + "type": "string" + }, "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, "status": { "type": "string", - "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" }, "reason": { "type": "string", - "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" }, "details": { "type": "array", @@ -136665,28 +141214,26 @@ "type": "string" } } - }, - "configurationStatus": { + } + } + }, + "paymentOrchestration": { + "type": "object", + "properties": { + "subscriptionStatus": { "type": "object", "properties": { - "configurationId": { - "type": "string", - "description": "This is NOT for MVP" - }, - "version": { - "type": "string" - }, "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, "status": { "type": "string", - "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" }, "reason": { "type": "string", - "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" }, "details": { "type": "array", @@ -136713,7 +141260,7 @@ } } }, - "cybsReadyTerminal": { + "payouts": { "type": "object", "properties": { "subscriptionStatus": { @@ -136801,7 +141348,7 @@ } } }, - "paymentOrchestration": { + "payByLink": { "type": "object", "properties": { "subscriptionStatus": { @@ -136844,7 +141391,7 @@ } } }, - "payouts": { + "unifiedCheckout": { "type": "object", "properties": { "subscriptionStatus": { @@ -136884,55 +141431,10 @@ "type": "string" } } - }, - "configurationStatus": { - "type": "object", - "properties": { - "configurationId": { - "type": "string", - "description": "This is NOT for MVP" - }, - "version": { - "type": "string" - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" - } - }, - "additionalProperties": { - "type": "string" - } - } - }, - "message": { - "type": "string" - } - } } } }, - "payByLink": { + "receivablesManager": { "type": "object", "properties": { "subscriptionStatus": { @@ -136975,7 +141477,7 @@ } } }, - "unifiedCheckout": { + "serviceFee": { "type": "object", "properties": { "subscriptionStatus": { @@ -137015,26 +141517,28 @@ "type": "string" } } - } - } - }, - "receivablesManager": { - "type": "object", - "properties": { - "subscriptionStatus": { + }, + "configurationStatus": { "type": "object", "properties": { + "configurationId": { + "type": "string", + "description": "This is NOT for MVP" + }, + "version": { + "type": "string" + }, "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, "status": { "type": "string", - "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" }, "reason": { "type": "string", - "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" }, "details": { "type": "array", @@ -137061,7 +141565,7 @@ } } }, - "serviceFee": { + "batchUpload": { "type": "object", "properties": { "subscriptionStatus": { @@ -137101,51 +141605,6 @@ "type": "string" } } - }, - "configurationStatus": { - "type": "object", - "properties": { - "configurationId": { - "type": "string", - "description": "This is NOT for MVP" - }, - "version": { - "type": "string" - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" - } - }, - "additionalProperties": { - "type": "string" - } - } - }, - "message": { - "type": "string" - } - } } } } @@ -145273,6 +149732,24 @@ } } } + }, + "batchUpload": { + "type": "object", + "properties": { + "subscriptionInformation": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "selfServiceability": { + "type": "string", + "default": "NOT_SELF_SERVICEABLE", + "description": "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY" + } + } + } + } } } }, @@ -147440,6 +151917,49 @@ } } } + }, + "batchUpload": { + "type": "object", + "properties": { + "subscriptionStatus": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + } + } } } }, @@ -151507,7 +156027,7 @@ "properties": { "clientVersion": { "type": "string", - "example": "0.25", + "example": "0.32", "maxLength": 60, "description": "Specify the version of Unified Checkout that you want to use." }, @@ -151536,7 +156056,7 @@ "items": { "type": "string" }, - "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - AFTERPAY

\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE)\n - DragonPay (PH)\n - iDEAL (NL)\n - Multibanco (PT)\n - MyBank (IT, BE, PT, ES)\n - Przelewy24|P24 (PL)\n - Tink Pay By Bank (GB)\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" + "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - AFTERPAY

\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE)\n - DragonPay (PH)\n - iDEAL (NL)\n - Multibanco (PT)\n - MyBank (IT, BE, PT, ES)\n - Przelewy24|P24 (PL)\n - Tink Pay By Bank (GB)

\n\n Unified Checkout supports the following Post-Pay Reference payment methods:\n - Konbini (JP)

\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" }, "country": { "type": "string", @@ -151549,6 +156069,11 @@ "example": "en_US", "description": "Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code.\n\nPlease refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html)\n" }, + "buttonType": { + "type": "string", + "example": null, + "description": "Changes the label on the payment button within Unified Checkout .

\n\nPossible values:\n- ADD_CARD\n- CARD_PAYMENT\n- CHECKOUT\n- CHECKOUT_AND_CONTINUE\n- DEBIT_CREDIT\n- DONATE\n- PAY\n- PAY_WITH_CARD\n- SAVE_CARD\n- SUBSCRIBE_WITH_CARD

\n\nThis is an optional field,\n" + }, "captureMandate": { "type": "object", "properties": { @@ -151705,6 +156230,23 @@ "type": "string", "example": 10, "description": "This field defines the tax amount applicable to the order.\n" + }, + "taxDetails": { + "type": "object", + "properties": { + "taxId": { + "type": "string", + "example": 1234, + "maxLength": 20, + "description": "This field defines the tax identifier/registration number\n" + }, + "type": { + "type": "string", + "example": "N", + "maxLength": 1, + "description": "This field defines the Tax type code (N=National, S=State, L=Local etc)\n" + } + } } } }, @@ -151971,188 +156513,225 @@ "productCode": { "type": "string", "maxLength": 255, - "example": "electronics" + "example": "electronics", + "description": "Code identifying the product." }, "productName": { "type": "string", "maxLength": 255, - "example": "smartphone" + "example": "smartphone", + "description": "Name of the product." }, "productSku": { "type": "string", "maxLength": 255, - "example": "SKU12345" + "example": "SKU12345", + "description": "Stock Keeping Unit identifier" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 999999999, "default": 1, - "example": 2 + "example": 2, + "description": "Quantity of the product" }, "unitPrice": { "type": "string", "maxLength": 15, - "example": "399.99" + "example": "399.99", + "description": "Price per unit" }, "unitOfMeasure": { "type": "string", "maxLength": 12, - "example": "EA" + "example": "EA", + "description": "Unit of measure (e.g. EA, KG, LB)" }, "totalAmount": { "type": "string", "maxLength": 13, - "example": "799.98" + "example": "799.98", + "description": "Total amount for the line item" }, "taxAmount": { "type": "string", "maxLength": 15, - "example": "64.00" + "example": "64.00", + "description": "Tax amount applied" }, "taxRate": { "type": "string", "maxLength": 7, - "example": "0.88" + "example": "0.88", + "description": "Tax rate applied" }, "taxAppliedAfterDiscount": { "type": "string", "maxLength": 1, - "example": "Y" + "example": "Y", + "description": "Indicates if tax applied after discount" }, "taxStatusIndicator": { "type": "string", "maxLength": 1, - "example": "N" + "example": "N", + "description": "Tax status indicator" }, "taxTypeCode": { "type": "string", "maxLength": 4, - "example": "VAT" + "example": "VAT", + "description": "Tax type code" }, "amountIncludesTax": { "type": "boolean", - "example": false + "example": false, + "description": "Indicates if amount includes tax" }, "typeOfSupply": { "type": "string", "maxLength": 2, - "example": "GS" + "example": "GS", + "description": "Type of supply" }, "commodityCode": { "type": "string", "maxLength": 15, - "example": "123456" + "example": "123456", + "description": "Commodity code" }, "discountAmount": { "type": "string", "maxLength": 13, - "example": "10.00" + "example": "10.00", + "description": "Discount amount applied" }, "discountApplied": { "type": "boolean", - "example": true + "example": true, + "description": "Indicates if discount applied" }, "discountRate": { "type": "string", "maxLength": 6, - "example": "0.05" + "example": "0.05", + "description": "Discount rate applied" }, "invoiceNumber": { "type": "string", "maxLength": 23, - "example": "INV-001" + "example": "INV-001", + "description": "Invoice number for the line item" }, "taxDetails": { "type": "object", "properties": { "type": { "type": "string", - "example": "VAT" + "example": "VAT", + "description": "Type of tax" }, "amount": { "type": "string", "maxLength": 13, - "example": 5.99 + "example": 5.99, + "description": "Tax amount" }, "rate": { "type": "string", "maxLength": 6, - "example": 20 + "example": 20, + "description": "Tax rate" }, "code": { "type": "string", "maxLength": 4, - "example": "VAT" + "example": "VAT", + "description": "Tax code" }, "taxId": { "type": "string", "maxLength": 15, - "example": "TAXID12345" + "example": "TAXID12345", + "description": "Tax Identifier" }, "applied": { "type": "boolean", - "example": true + "example": true, + "description": "Indicates if tax applied" }, "exemptionCode": { "type": "string", "maxLength": 1, - "example": "E" + "example": "E", + "description": "Tax exemption code" } } }, "fulfillmentType": { "type": "string", - "example": "Delivery" + "example": "Delivery", + "description": "Fulfillment type" }, "weight": { "type": "string", "maxLength": 9, - "example": "1.5" + "example": "1.5", + "description": "Weight of the product" }, "weightIdentifier": { "type": "string", "maxLength": 1, - "example": "N" + "example": "N", + "description": "Weight identifier" }, "weightUnit": { "type": "string", "maxLength": 2, - "example": "KG" + "example": "KG", + "description": "Unit of weight of the product" }, "referenceDataCode": { "type": "string", "maxLength": 150, - "example": "REFCODE" + "example": "REFCODE", + "description": "Reference data code" }, "referenceDataNumber": { "type": "string", "maxLength": 30, - "example": "REF123" + "example": "REF123", + "description": "Reference data number" }, "unitTaxAmount": { "type": "string", "maxLength": 15, - "example": "3.20" + "example": "3.20", + "description": "Unit tax amount" }, "productDescription": { "type": "string", "maxLength": 30, - "example": "Latest model smartphone" + "example": "Latest model smartphone", + "description": "Description of the product" }, "giftCardCurrency": { "type": "string", "maxLength": 3, - "example": "USD" + "example": "USD", + "description": "Gift card currency" }, "shippingDestinationTypes": { "type": "string", "maxLength": 50, - "example": "Residential" + "example": "Residential", + "description": "Shipping destination types" }, "gift": { "type": "boolean", - "example": false + "example": false, + "description": "Indicates if item is a gift" }, "passenger": { "type": "object", @@ -152160,46 +156739,71 @@ "type": { "type": "string", "maxLength": 50, - "example": "Residential" + "example": "Residential", + "description": "Passenger type" }, "status": { "type": "string", "maxLength": 32, - "example": "Gold" + "example": "Gold", + "description": "Passenger status" }, "phone": { "type": "string", "maxLength": 15, - "example": "123456789" + "example": "123456789", + "description": "Passenger phone number" }, "firstName": { "type": "string", "maxLength": 60, - "example": "John" + "example": "John", + "description": "Passenger first name" }, "lastName": { "type": "string", "maxLength": 60, - "example": "Doe" + "example": "Doe", + "description": "Passenger last name" }, "id": { "type": "string", "maxLength": 40, - "example": "AIR1234567" + "example": "AIR1234567", + "description": "Passenger ID" }, "email": { "type": "string", "maxLength": 50, - "example": "john.doe@example.com" + "example": "john.doe@example.com", + "description": "Passenger email" }, "nationality": { "type": "string", "maxLength": 2, - "example": "US" + "example": "US", + "description": "Passenger nationality" } } } } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "invoiceNumber": { + "type": "string", + "maxLength": 255, + "example": "electronics", + "description": "Invoice number" + }, + "productDescription": { + "type": "string", + "maxLength": 255, + "example": "electronics", + "description": "Product description" + } + } } } }, @@ -152211,21 +156815,35 @@ "properties": { "cpf": { "type": "string", - "minLength": 11, "maxLength": 11, - "example": "12345678900" + "example": "12345678900", + "description": "CPF Number (Brazil). Must be 11 digits in length.\n" } } }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "example": "M123456767" + "example": "M123456767", + "description": "The Merchant Customer ID\n" }, "companyTaxId": { "type": "string", "maxLength": 9, - "example": "" + "example": "", + "description": "The Company Tax ID\n" + }, + "dateOfBirth": { + "type": "string", + "maxLength": 10, + "example": "12/03/1976", + "description": "The date of birth\n" + }, + "language": { + "type": "string", + "maxLength": 10, + "example": "English", + "description": "The preferred language\n" } } }, @@ -152245,7 +156863,7 @@ "maxLength": 8, "example": "DEV12345" }, - "SolutionId": { + "solutionId": { "type": "string", "maxLength": 8, "example": "SOL1234" @@ -152260,12 +156878,20 @@ "challengeCode": { "type": "string", "maxLength": 2, - "example": "01" + "example": "01", + "description": "The challenge code\n" }, "messageCategory": { "type": "string", "maxLength": 2, - "example": "01" + "example": "01", + "description": "The message category\n" + }, + "acsWindowSize": { + "type": "string", + "maxLength": 2, + "example": "01", + "description": "The acs window size\n" } } }, @@ -152277,9 +156903,51 @@ "properties": { "name": { "type": "string", - "maxLength": 22, + "maxLength": 25, "example": "Euro Electronics", "description": "The name of the merchant" + }, + "alternateName": { + "type": "string", + "maxLength": 25, + "example": "Smyth Holdings PLC", + "description": "The alternate name of the merchant" + }, + "locality": { + "type": "string", + "maxLength": 50, + "example": "New York", + "description": "The locality of the merchant" + }, + "phone": { + "type": "string", + "maxLength": 15, + "example": "555-555-123", + "description": "The phone number of the merchant" + }, + "country": { + "type": "string", + "maxLength": 2, + "example": "US", + "description": "The country code of the merchant" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "example": "170056", + "description": "The postal code of the merchant" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "example": "NY", + "description": "The administrative area of the merchant" + }, + "address1": { + "type": "string", + "maxLength": 60, + "example": "123 47th Street", + "description": "The first line of the merchant's address" } } } @@ -152291,28 +156959,46 @@ "reconciliationId": { "type": "string", "maxLength": 60, - "example": "01234567" + "example": "01234567", + "description": "The reconciliation ID" }, "authorizationOptions": { "type": "object", "properties": { "aftIndicator": { "type": "boolean", - "example": true + "example": true, + "description": "The AFT indicator" + }, + "authIndicator": { + "type": "string", + "example": 1, + "description": "The authorization indicator" + }, + "ignoreCvResult": { + "type": "boolean", + "example": true, + "description": "Ignore the CV result" + }, + "ignoreAvsResult": { + "type": "boolean", + "example": true, + "description": "Ignore the AVS result" }, "initiator": { "type": "object", "properties": { "credentialStoredOnFile": { "type": "boolean", - "example": true + "example": true, + "description": "Store the credential on file" }, "merchantInitiatedTransaction": { "type": "object", "properties": { "reason": { "type": "string", - "maxLength": 1, + "maxLength": 2, "example": 1 } } @@ -152322,7 +157008,20 @@ "businessApplicationId": { "type": "string", "maxLength": 2, - "example": "AA" + "example": "AA", + "description": "The business application Id" + }, + "commerceIndicator": { + "type": "string", + "maxLength": 20, + "example": "INDICATOR", + "description": "The commerce indicator" + }, + "processingInstruction": { + "type": "string", + "maxLength": 50, + "example": "ORDER_SAVED_EXPLICITLY", + "description": "The processing instruction" } } } @@ -152361,14 +157060,26 @@ "administrativeArea": { "type": "string", "maxLength": 2, - "example": "Devon", + "example": "GB", "description": "The administrative area of the recipient" }, "accountType": { "type": "string", "maxLength": 2, - "example": "Checking", + "example": "01", "description": "The account type of the recipient" + }, + "dateOfBirth": { + "type": "string", + "maxLength": 8, + "example": "05111999", + "description": "The date of birth of the recipient" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "example": "170056", + "description": "The postal code of the recipient" } } }, @@ -152377,20 +157088,50 @@ "properties": { "key": { "type": "string", - "maxLength": 50, + "maxLength": 10, + "example": "1", "description": "The key or identifier for the merchant-defined data field" }, "value": { "type": "string", - "maxLength": 255, + "maxLength": 100, + "example": "123456", "description": "The value associated with the merchant-defined data field" } } + }, + "deviceInformation": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "maxLength": 45, + "example": "192.168.1.1", + "description": "The IP Address" + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "typeSelectionIndicator": { + "type": "string", + "maxLength": 1, + "example": "0", + "description": "The card type selection indicator" + } + } + } + } } } }, "orderInformation": { "type": "object", + "description": "If you need to include any fields within the data object, you must use the orderInformation object that is nested inside the data object. This ensures proper structure and compliance with the Unified Checkout schema. This top-level orderInformation field is not intended for use when working with the data object.", "properties": { "amountDetails": { "type": "object", @@ -152674,7 +157415,7 @@ "example0": { "summary": "Generate Unified Checkout Capture Context", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152709,10 +157450,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -152720,7 +157463,7 @@ "example1": { "summary": "Generate Unified Checkout Capture Context With Full List of Card Networks", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152784,7 +157527,7 @@ "example2": { "summary": "Generate Unified Checkout Capture Context With Custom Google Payment Options", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152840,7 +157583,7 @@ "example3": { "summary": "Generate Unified Checkout Capture Context With Autocheck Enrollment", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152890,7 +157633,7 @@ "example4": { "summary": "Generate Unified Checkout Capture Context (Opt-out of receiving card number prefix)", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152941,7 +157684,7 @@ "example5": { "summary": "Generate Unified Checkout Capture Context passing Billing & Shipping", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153036,7 +157779,7 @@ "example6": { "summary": "Generate Unified Checkout Capture Context For Click To Pay Drop-In UI", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153074,7 +157817,7 @@ "example7": { "summary": "Generate Unified Checkout Capture Context ($ Afterpay (US))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153145,7 +157888,7 @@ "example8": { "summary": "Generate Unified Checkout Capture Context (Afterpay (CAN))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153216,7 +157959,7 @@ "example9": { "summary": "Generate Unified Checkout Capture Context (Clearpay (GB))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153289,7 +158032,7 @@ "example10": { "summary": "Generate Unified Checkout Capture Context (Afterpay (AU))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153360,7 +158103,7 @@ "example11": { "summary": "Generate Unified Checkout Capture Context (Afterpay (NZ))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153429,9 +158172,153 @@ "parentTag": "Unified Checkout with Alternate Payments (Buy Now, Pay Later)" }, "example12": { + "summary": "Generate Unified Checkout Capture Context (Bancontact (BE))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "BANCONTACT" + ], + "country": "BE", + "locale": "fr_BE", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "BE", + "NL", + "FR" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "jean.dupont@example.com", + "firstName": "Jean", + "lastName": "Dupont", + "address1": "Avenue Louise 123", + "administrativeArea": "Brussels", + "buildingNumber": 123, + "country": "BE", + "locality": "Brussels", + "postalCode": "1050" + }, + "shipTo": { + "firstName": "Marie", + "lastName": "Dupont", + "address1": "Rue de la Loi 200", + "administrativeArea": "Brussels", + "buildingNumber": 200, + "country": "BE", + "locality": "Brussels", + "postalCode": "1040" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example13": { + "summary": "Generate Unified Checkout Capture Context (DragonPay (PH))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "DRAGONPAY" + ], + "country": "PH", + "locale": "en-PH", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "PH", + "SG", + "MY" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "121.00", + "currency": "PHP" + }, + "billTo": { + "email": "juan.dela.cruz@example.com", + "firstName": "Juan", + "lastName": "Dela Cruz", + "address1": "123 Ayala Avenue", + "administrativeArea": "NCR", + "buildingNumber": 123, + "country": "PH", + "locality": "Makati City", + "postalCode": "1226" + }, + "shipTo": { + "firstName": "Maria", + "lastName": "Dela Cruz", + "address1": "45 Ortigas Center", + "administrativeArea": "NCR", + "buildingNumber": 45, + "country": "PH", + "locality": "Pasig City", + "postalCode": "1605" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example14": { "summary": "Generate Unified Checkout Capture Context (iDEAL (NL))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153499,10 +158386,10 @@ }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" }, - "example13": { + "example15": { "summary": "Generate Unified Checkout Capture Context (Multibanco (PT))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153571,10 +158458,83 @@ }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" }, - "example14": { + "example16": { + "summary": "Generate Unified Checkout Capture Context (MyBank (IT))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "MYBBT" + ], + "country": "IT", + "locale": "it-IT", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "IT", + "ES", + "BE", + "PT" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "mario.rossi@example.com", + "firstName": "Mario", + "lastName": "Rossi", + "address1": "Via Dante Alighieri 15", + "administrativeArea": "MI", + "buildingNumber": 15, + "country": "IT", + "locality": "Milano", + "postalCode": "20121" + }, + "shipTo": { + "firstName": "Lucia", + "lastName": "Rossi", + "address1": "Corso Vittorio Emanuele II 8", + "administrativeArea": "RM", + "buildingNumber": 8, + "country": "IT", + "locality": "Roma", + "postalCode": "00186" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example17": { "summary": "Generate Unified Checkout Capture Context (Przelewy24|P24 (PL))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153643,10 +158603,10 @@ }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" }, - "example15": { + "example18": { "summary": "Generate Unified Checkout Capture Context (Tink Pay By Bank (GB))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153712,6 +158672,78 @@ } }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example19": { + "summary": "Generate Unified Checkout Capture Context (Konbini (JP))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "KONBINI" + ], + "country": "JP", + "locale": "ja-JP", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "JP", + "US" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "JPY" + }, + "billTo": { + "email": "taro.suzuki@example.jp", + "firstName": "Taro", + "lastName": "Suzuki", + "address1": "1-9-1 Marunouchi", + "administrativeArea": "Tokyo", + "buildingNumber": 1, + "country": "JP", + "locality": "Chiyoda-ku", + "postalCode": "100-0005", + "phoneNumber": "0312345678" + }, + "shipTo": { + "firstName": "Hanako", + "lastName": "Suzuki", + "address1": "3-1-1 Umeda", + "administrativeArea": "Osaka", + "buildingNumber": 3, + "country": "JP", + "locality": "Kita-ku", + "postalCode": "530-0001" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Post-Pay Reference)" } }, "responses": { @@ -155215,7 +160247,7 @@ "authorizationType": [ "Json Web Token" ], - "overrideMerchantCredential": "echecktestdevcenter001", + "overrideMerchantCredential": "apiref_chase", "SDK_ONLY_AddDisclaimer": true }, "consumes": [ diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 77d450b9b..b3b3e5905 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -65,6 +65,10 @@ "name": "payment-tokens", "description": "A payment-tokens is a service that is used for retrieving vault details or deleting vault id/payment method.\n" }, + { + "name": "Tokenize", + "description": "An orchestration resource used to combine multiple API calls into a single request.\n" + }, { "name": "Customer", "description": "A Customer can be linked to multiple Payment Instruments and Shipping Addresses.\nWith one Payment Instrument and Shipping Address designated as the default.\nIt stores merchant reference information for the Customer such as email and merchant defined data.\n" @@ -85,6 +89,10 @@ "name": "Instrument Identifier", "description": "An Instrument Identifier represents a unique card number(PAN) or bank account (echeck).\nIt can also be associated with a Network Token that can be used for payment transactions.\n" }, + { + "name": "Tokenized Card", + "description": "A Tokenized Card represents a Network Token that can be used for payment transactions.\n" + }, { "name": "Token", "description": "Token resources can act on different token types such as Customers, Payment Instruments or Instrument Identifiers.\n" @@ -3135,6 +3143,11 @@ "type": "string", "maxLength": 10, "description": "Acquirer country." + }, + "serviceProvidername": { + "type": "string", + "maxLength": 50, + "description": "Contains transfer service provider name." } } }, @@ -47498,10 +47511,10 @@ } } }, - "/tms/v2/customers": { + "/tms/v2/tokenize": { "post": { - "summary": "Create a Customer", - "description": "| | | |\n| --- | --- | --- |\n|**Customers**
A Customer represents your tokenized customer information.
You should associate the Customer Id with the customer account on your systems.
A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.

**Creating a Customer**
It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
The Customer will be created with a Payment Instrument and Shipping Address.
You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).
For more information about Payment Network Tokens see the Developer Guide.

**Payments with Customers**
To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).
To perform a payment with a particular Payment Instrument or Shipping Address
specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).\nThe availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.\n", + "summary": "Tokenize", + "description": "| | | | \n| --- | --- | --- |\n|The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **\"TOKEN_CREATE\"** and the types of tokens to be created. The **tokenInformation** section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|      |The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.
In cases where token creation encounters issues, the response includes a **non-2XX** status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.\n", "parameters": [ { "name": "profile-id", @@ -47514,154 +47527,53 @@ "x-hide-field": true }, { - "name": "postCustomerRequest", + "name": "postTokenizeRequest", "in": "body", "required": true, "schema": { "type": "object", "properties": { - "_links": { + "processingInformation": { "type": "object", - "readOnly": true, "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Customer.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" - } - } - }, - "paymentInstruments": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Customers Payment Instruments.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" - } - } + "actionList": { + "type": "array", + "description": "Array of actions (one or more) to be included in the tokenize request.\n\nPossible Values:\n\n - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your tokenize request.\n", + "items": { + "type": "string" + }, + "example": [ + "TOKEN_CREATE" + ] }, - "shippingAddress": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Customers Shipping Addresses.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses" - } - } + "actionTokenTypes": { + "type": "array", + "description": "TMS tokens types you want to perform the action on.\n\nPossible Values:\n- customer\n- paymentInstrument\n- instrumentIdentifier\n- shippingAddress\n- tokenizedCard\n", + "items": { + "type": "string" + }, + "example": [ + "customer", + "paymentInstrument", + "shippingAddress", + "instrumentIdentifier" + ] } } }, - "id": { - "type": "string", - "minLength": 1, - "maxLength": 32, - "description": "The Id of the Customer Token." - }, - "objectInformation": { + "tokenInformation": { "type": "object", "properties": { - "title": { + "jti": { "type": "string", - "description": "Name or title of the customer.\n", - "maxLength": 60 + "maxLength": 64, + "description": "TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV).\n" }, - "comment": { - "type": "string", - "description": "Comments that you can make about the customer.\n", - "maxLength": 150 - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerID": { + "transientTokenJwt": { "type": "string", - "description": "Your identifier for the customer.\n", - "maxLength": 100 + "description": "Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result.\n" }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's primary email address, including the full domain name.\n" - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Client-generated order reference or tracking number.\n", - "maxLength": 50 - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "Object containing the custom data that the merchant defines.\n", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4\n\nFor example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2\nPossible Values:\n- data1\n- data2\n- data3\n- data4\n- sensitive1\n- sensitive2\n- sensitive3\n- sensitive4\n" - }, - "value": { - "type": "string", - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n", - "maxLength": 100 - } - } - } - }, - "defaultPaymentInstrument": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Id of the Customers default Payment Instrument\n" - } - } - }, - "defaultShippingAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Id of the Customers default Shipping Address\n" - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "readOnly": true, - "description": "The creator of the Customer.\n" - } - } - }, - "_embedded": { - "type": "object", - "readOnly": true, - "description": "Additional resources for the Customer.\n", - "properties": { - "defaultPaymentInstrument": { - "readOnly": true, + "customer": { "type": "object", "properties": { "_links": { @@ -47675,20 +47587,32 @@ "href": { "type": "string", "readOnly": true, - "description": "Link to the Payment Instrument.\n", + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Payment Instruments.\n", "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" } } }, - "customer": { + "shippingAddress": { "type": "object", "readOnly": true, "properties": { "href": { "type": "string", "readOnly": true, - "description": "Link to the Customer.\n", - "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + "description": "Link to the Customers Shipping Addresses.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses" } } } @@ -47698,251 +47622,81 @@ "type": "string", "minLength": 1, "maxLength": 32, - "description": "The Id of the Payment Instrument Token." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "paymentInstrument", - "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + "description": "The Id of the Customer Token." }, - "default": { - "type": "boolean", - "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 18, - "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" - } - } - }, - "card": { + "objectInformation": { "type": "object", "properties": { - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" - }, - "type": { - "type": "string", - "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 2, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { + "title": { "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + "description": "Name or title of the customer.\n", + "maxLength": 60 }, - "useAs": { + "comment": { "type": "string", - "example": "pinless debit", - "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" - }, - "hash": { - "type": "string", - "minLength": 32, - "maxLength": 34, - "readOnly": true, - "description": "Hash value representing the card.\n" - }, - "tokenizedInformation": { - "type": "object", - "properties": { - "requestorID": { - "type": "string", - "maxLength": 11, - "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" - }, - "transactionType": { - "type": "string", - "maxLength": 1, - "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" - } - } + "description": "Comments that you can make about the customer.\n", + "maxLength": 150 } } }, "buyerInformation": { "type": "object", "properties": { - "companyTaxID": { - "type": "string", - "maxLength": 9, - "description": "Company's tax identifier. This is only used for eCheck service.\n" - }, - "currency": { + "merchantCustomerID": { "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your identifier for the customer.\n", + "maxLength": 100 }, - "dateOfBirth": { + "email": { "type": "string", - "format": "date", - "example": "1960-12-30", - "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "The value of the identification type.\n" - }, - "type": { - "type": "string", - "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", - "maxLength": 20 - } - } - } - } - } + "maxLength": 255, + "description": "Customer's primary email address, including the full domain name.\n" } } }, - "billTo": { + "clientReferenceInformation": { "type": "object", "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer's first name. This name must be the same as the name on the card.\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer's last name. This name must be the same as the name on the card.\n" - }, - "company": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer's company.\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "Payment card billing city.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 20, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" - }, - "country": { + "code": { "type": "string", - "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer's phone number.\n" + "description": "Client-generated order reference or tracking number.\n", + "maxLength": 50 } } }, - "processingInformation": { - "type": "object", - "title": "tmsPaymentInstrumentProcessingInfo", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" - } + "merchantDefinedInformation": { + "type": "array", + "description": "Object containing the custom data that the merchant defines.\n", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4\n\nFor example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2\nPossible Values:\n- data1\n- data2\n- data3\n- data4\n- sensitive1\n- sensitive2\n- sensitive3\n- sensitive4\n" + }, + "value": { + "type": "string", + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n", + "maxLength": 100 } } } }, - "merchantInformation": { + "defaultPaymentInstrument": { "type": "object", "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", - "maxLength": 13 - } - } + "id": { + "type": "string", + "description": "The Id of the Customers default Payment Instrument\n" } } }, - "instrumentIdentifier": { + "defaultShippingAddress": { "type": "object", "properties": { "id": { "type": "string", - "minLength": 12, - "maxLength": 32, - "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + "description": "The Id of the Customers default Shipping Address\n" } } }, @@ -47953,18 +47707,17 @@ "creator": { "type": "string", "readOnly": true, - "description": "The creator of the Payment Instrument.\n" + "description": "The creator of the Customer.\n" } } }, "_embedded": { "type": "object", "readOnly": true, - "description": "Additional resources for the Payment Instrument.\n", + "description": "Additional resources for the Customer.\n", "properties": { - "instrumentIdentifier": { + "defaultPaymentInstrument": { "readOnly": true, - "title": "tmsEmbeddedInstrumentIdentifier", "type": "object", "properties": { "_links": { @@ -47978,20 +47731,20 @@ "href": { "type": "string", "readOnly": true, - "description": "Link to the Instrument Identifier.\n", - "example": "tms/v1/instrumentidentifiers/7010000000016241111" + "description": "Link to the Payment Instrument.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" } } }, - "paymentInstruments": { + "customer": { "type": "object", "readOnly": true, "properties": { "href": { "type": "string", "readOnly": true, - "description": "Link to the Instrument Identifiers Payment Instruments.\n", - "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" } } } @@ -47999,13 +47752,19 @@ }, "id": { "type": "string", - "description": "The Id of the Instrument Identifier Token.\n" + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Payment Instrument Token." }, "object": { "type": "string", "readOnly": true, - "example": "instrumentIdentifier", - "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + "example": "paymentInstrument", + "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" }, "state": { "type": "string", @@ -48015,35 +47774,22 @@ }, "type": { "type": "string", - "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" - }, - "source": { - "type": "string", - "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + "readOnly": true, + "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" }, - "tokenProvisioningInformation": { + "bankAccount": { "type": "object", "properties": { - "consumerConsentObtained": { - "type": "boolean", - "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" - }, - "multiFactorAuthenticated": { - "type": "boolean", - "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + "type": { + "type": "string", + "maxLength": 18, + "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" } } }, "card": { "type": "object", - "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", "properties": { - "number": { - "type": "string", - "minLength": 12, - "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" - }, "expirationMonth": { "type": "string", "maxLength": 2, @@ -48054,474 +47800,94 @@ "maxLength": 4, "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" }, - "securityCode": { - "type": "string", - "maxLength": 4, - "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "required": [ - "emvTags" - ], - "properties": { - "emvTags": { - "type": "array", - "minItems": 1, - "maxItems": 50, - "items": { - "type": "object", - "required": [ - "tag", - "value", - "source" - ], - "properties": { - "tag": { - "type": "string", - "minLength": 1, - "maxLength": 10, - "pattern": "^[0-9A-Fa-f]{1,10}$", - "description": "EMV tag, 1-10 hex characters." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 64, - "description": "EMV tag value, 1-64 characters." - }, - "source": { - "type": "string", - "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" - } - }, - "example": { - "tag": "5A", - "value": "4111111111111111", - "source": "CARD" - } - } - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 17, - "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" - }, - "routingNumber": { - "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" - } - } - }, - "tokenizedCard": { - "title": "tmsv2TokenizedCard", - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "description": "The Id of the Tokenized Card.\n" - }, - "object": { - "type": "string", - "readOnly": true, - "example": "tokenizedCard", - "description": "The type.\nPossible Values:\n- tokenizedCard\n" - }, - "accountReferenceId": { - "type": "string", - "description": "An identifier provided by the issuer for the account.\n" - }, - "consumerId": { - "type": "string", - "maxLength": 36, - "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." - }, - "createInstrumentIdentifier": { - "type": "boolean", - "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" - }, - "source": { - "type": "string", - "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" - }, - "reason": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" - }, - "number": { - "type": "string", - "readOnly": true, - "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" - }, - "expirationMonth": { - "type": "string", - "readOnly": true, - "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "readOnly": true, - "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" - }, "type": { "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" }, - "cryptogram": { + "issueNumber": { "type": "string", - "readOnly": true, - "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", - "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" - }, - "securityCode": { - "type": "string", - "readOnly": true, - "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", - "example": "4523" - }, - "eci": { - "type": "string", - "readOnly": true, - "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" }, - "requestorId": { + "startMonth": { "type": "string", - "readOnly": true, - "maxLength": 11, - "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" }, - "enrollmentId": { + "startYear": { "type": "string", - "readOnly": true, - "description": "Unique id to identify this PAN/ enrollment.\n" + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" }, - "tokenReferenceId": { + "useAs": { "type": "string", - "readOnly": true, - "description": "Unique ID for netwrok token.\n" + "example": "pinless debit", + "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" }, - "paymentAccountReference": { + "hash": { "type": "string", + "minLength": 32, + "maxLength": 34, "readOnly": true, - "description": "Payment account reference.\n" + "description": "Hash value representing the card.\n" }, - "card": { + "tokenizedInformation": { "type": "object", - "description": "Card object used to create a network token\n", "properties": { - "number": { - "type": "string", - "minLength": 12, - "maxLength": 19, - "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" - }, - "type": { + "requestorID": { "type": "string", - "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" }, - "suffix": { + "transactionType": { "type": "string", - "readOnly": true, - "description": "The customer's latest payment card number suffix.\n" - }, - "issueDate": { - "type": "string", - "readOnly": true, - "format": "date", - "description": "Card issuance date. XML date format: YYYY-MM-DD.", - "example": "2030-12-15" - }, - "activationDate": { - "type": "string", - "readOnly": true, - "format": "date", - "description": "Card activation date. XML date format: YYYY-MM-DD", - "example": "2030-12-20" - }, - "expirationPrinted": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if the expiration date is printed on the card.", - "example": true - }, - "securityCodePrinted": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if the Card Verification Number is printed on the card.", - "example": true - }, - "termsAndConditions": { - "type": "object", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "readOnly": true, - "description": "Issuer Card Terms and Conditions url." - } - } - } - } - }, - "passcode": { - "type": "object", - "description": "Passcode by issuer for ID&V.\n", - "properties": { - "value": { - "type": "string", - "description": "OTP generated at issuer.\n" - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "description": "Metadata associated with the tokenized card.\n", - "properties": { - "cardArt": { - "title": "TmsCardArt", - "description": "Card art associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "foregroundColor": { - "description": "Card foreground color.\n", - "type": "string", - "readOnly": true - }, - "combinedAsset": { - "description": "Combined card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" - } - } - } - } - } - } - }, - "brandLogoAsset": { - "description": "Brand logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" - } - } - } - } - } - } - }, - "issuerLogoAsset": { - "description": "Issuer logo card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" - } - } - } - } - } - } - }, - "iconAsset": { - "description": "Icon card art asset associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the asset\n" - }, - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "readOnly": true, - "properties": { - "href": { - "type": "string", - "readOnly": true, - "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" - } - } - } - } - } - } - } - } - }, - "issuer": { - "description": "Issuer associated with the tokenized card.\n", - "type": "object", - "readOnly": true, - "properties": { - "name": { - "description": "Issuer name.\n", - "type": "string", - "readOnly": true - }, - "shortDescription": { - "description": "Short description of the card.\n", - "type": "string", - "readOnly": true - }, - "longDescription": { - "description": "Long description of the card.\n", - "type": "string", - "readOnly": true - }, - "email": { - "type": "string", - "readOnly": true, - "description": "Issuer customer service email address." - }, - "phoneNumber": { - "type": "string", - "readOnly": true, - "description": "Issuer customer service phone number." - }, - "url": { - "type": "string", - "readOnly": true, - "description": "Issuer customer service url." - } - } + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" } } } } }, - "issuer": { + "buyerInformation": { "type": "object", - "readOnly": true, "properties": { - "paymentAccountReference": { + "companyTaxID": { "type": "string", - "readOnly": true, - "maxLength": 32, - "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "title": "tmsAuthorizationOptions", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "maxLength": 15, - "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" - }, - "originalAuthorizedAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount of the original authorization.\n" - } + "maxLength": 9, + "description": "Company's tax identifier. This is only used for eCheck service.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "dateOfBirth": { + "type": "string", + "format": "date", + "example": "1960-12-30", + "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type.\n" + }, + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", + "maxLength": 20 } } } @@ -48532,7 +47898,4760 @@ }, "billTo": { "type": "object", - "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer's company.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer's phone number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "title": "tmsPaymentInstrumentProcessingInfo", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "title": "TmsMerchantInformation", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", + "maxLength": 13 + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "minLength": 12, + "maxLength": 32, + "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Payment Instrument.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Payment Instrument.\n", + "properties": { + "instrumentIdentifier": { + "readOnly": true, + "title": "tmsEmbeddedInstrumentIdentifier", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Instrument Identifier." + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "properties": { + "binLookup": { + "title": "TmsBinLookup", + "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n", + "readOnly": true, + "type": "object", + "properties": { + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n" + }, + "sharedBIN": { + "type": "boolean", + "description": "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n" + }, + "posDomesticOnly": { + "type": "boolean", + "description": "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n" + }, + "gamblingAllowed": { + "type": "boolean", + "description": "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel2": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel3": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "exemptBIN": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n" + }, + "accountLevelManagement": { + "type": "boolean", + "description": "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n" + }, + "onlineGamblingBlock": { + "type": "boolean", + "description": "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "autoSubstantiation": { + "type": "boolean", + "description": "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "flexCredential": { + "type": "boolean", + "description": "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n" + }, + "productId": { + "type": "string", + "description": "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n" + }, + "productIdSubtype": { + "type": "string", + "description": "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n" + }, + "threeDSSupport": { + "type": "boolean", + "description": "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n" + }, + "siEligible": { + "type": "boolean", + "description": "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n" + }, + "emiEligible": { + "type": "boolean", + "description": "This field indicates if the card is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "defaultShippingAddress": { + "readOnly": true, + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Shipping Address\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses/D9F3439F0448C901E053A2598D0AA1CC" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Shipping Address Token." + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer shipping address is the dafault.\nPossible Values:\n - `true`: Shipping Address is customer's default.\n - `false`: Shipping Address is not customer's default.\n" + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Company associated with the shipping address.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the shipping address. Use 2 character the State,\nProvince, and Territory Codes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.\n", + "maxLength": 2 + }, + "email": { + "type": "string", + "maxLength": 320, + "description": "Email associated with the shipping address.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Shipping Address." + } + } + } + } + } + } + } + } + }, + "shippingAddress": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Shipping Address\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses/D9F3439F0448C901E053A2598D0AA1CC" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Shipping Address Token." + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer shipping address is the dafault.\nPossible Values:\n - `true`: Shipping Address is customer's default.\n - `false`: Shipping Address is not customer's default.\n" + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Company associated with the shipping address.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the shipping address. Use 2 character the State,\nProvince, and Territory Codes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.\n", + "maxLength": 2 + }, + "email": { + "type": "string", + "maxLength": 320, + "description": "Email associated with the shipping address.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Shipping Address." + } + } + } + } + }, + "paymentInstrument": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Payment Instrument.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Payment Instrument Token." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "paymentInstrument", + "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 18, + "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" + }, + "hash": { + "type": "string", + "minLength": 32, + "maxLength": 34, + "readOnly": true, + "description": "Hash value representing the card.\n" + }, + "tokenizedInformation": { + "type": "object", + "properties": { + "requestorID": { + "type": "string", + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" + }, + "transactionType": { + "type": "string", + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "maxLength": 9, + "description": "Company's tax identifier. This is only used for eCheck service.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "dateOfBirth": { + "type": "string", + "format": "date", + "example": "1960-12-30", + "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type.\n" + }, + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", + "maxLength": 20 + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer's company.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer's phone number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "title": "tmsPaymentInstrumentProcessingInfo", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "title": "TmsMerchantInformation", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", + "maxLength": 13 + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "minLength": 12, + "maxLength": 32, + "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Payment Instrument.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Payment Instrument.\n", + "properties": { + "instrumentIdentifier": { + "readOnly": true, + "title": "tmsEmbeddedInstrumentIdentifier", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Instrument Identifier." + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "properties": { + "binLookup": { + "title": "TmsBinLookup", + "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n", + "readOnly": true, + "type": "object", + "properties": { + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n" + }, + "sharedBIN": { + "type": "boolean", + "description": "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n" + }, + "posDomesticOnly": { + "type": "boolean", + "description": "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n" + }, + "gamblingAllowed": { + "type": "boolean", + "description": "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel2": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel3": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "exemptBIN": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n" + }, + "accountLevelManagement": { + "type": "boolean", + "description": "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n" + }, + "onlineGamblingBlock": { + "type": "boolean", + "description": "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "autoSubstantiation": { + "type": "boolean", + "description": "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "flexCredential": { + "type": "boolean", + "description": "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n" + }, + "productId": { + "type": "string", + "description": "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n" + }, + "productIdSubtype": { + "type": "string", + "description": "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n" + }, + "threeDSSupport": { + "type": "boolean", + "description": "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n" + }, + "siEligible": { + "type": "boolean", + "description": "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n" + }, + "emiEligible": { + "type": "boolean", + "description": "This field indicates if the card is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Instrument Identifier." + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "properties": { + "binLookup": { + "title": "TmsBinLookup", + "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n", + "readOnly": true, + "type": "object", + "properties": { + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.\nPossible values from BIN Lookup Service (based on availability and enablement):\n- `000`: Unsupported Card Type\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `007`: JCB\n- `036`: Cartes Bancaire\n- `042`: Maestro\n- `054`: Elo\n- `058`: Carnet\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `064`: Prompt Card\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `081`: Jaywan\n- `082`: TPN\n\nGlossary of possible values in the payments ecosystem:\n- `001`: Visa\n- `002`: Mastercard\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche\n- `007`: JCB\n- `008`: Optima\n- `009`: GE Private Label\n- `010`: Beneficial Private Label\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: EnRoute\n- `015`: Lowe's Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sam's Club Consumer\n- `026`: Sam's Club Business\n- `027`: Nico's\n- `028`: Paymentech Bill Me Later\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta Online\n- `032`: Solo\n- `033`: Visa Electron\n- `034`: Dankort\n- `035`: Laser\n- `036`: Cartes Bancaire\n- `037`: Carta Si\n- `040`: UATP\n- `041`: HOUSEHOLD\n- `042`: Maestro\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style Cards\n- `046`: J.Crew\n- `047`: Payeasecn eWallet\n- `048`: Payeasecn Bank Transfer\n- `049`: Meijer\n- `050`: Hipercard\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo\n- `055`: Capital One Private Label\n- `057`: Costco Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `060`: MADA\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n- `067`: Meeza\n- `068`: PayPak\n- `070`: EFTPOS\n- `071`: Codensa\n- `072`: Olimpica\n- `073`: Colsubsidio\n- `074`: Tuya\n- `075`: Sodexo\n- `076`: Naranja\n- `077`: Cabal\n- `078`: DINELCO\n- `079`: PANAL\n- `080`: EPM\n- `081`: Jaywan\n- `082`: TPN\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n" + }, + "sharedBIN": { + "type": "boolean", + "description": "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n" + }, + "posDomesticOnly": { + "type": "boolean", + "description": "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n" + }, + "gamblingAllowed": { + "type": "boolean", + "description": "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel2": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "commercialCardLevel3": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n" + }, + "exemptBIN": { + "type": "boolean", + "description": "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n" + }, + "accountLevelManagement": { + "type": "boolean", + "description": "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n" + }, + "onlineGamblingBlock": { + "type": "boolean", + "description": "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "autoSubstantiation": { + "type": "boolean", + "description": "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n" + }, + "flexCredential": { + "type": "boolean", + "description": "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n" + }, + "productId": { + "type": "string", + "description": "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n" + }, + "productIdSubtype": { + "type": "string", + "description": "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n" + }, + "threeDSSupport": { + "type": "boolean", + "description": "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n" + }, + "siEligible": { + "type": "boolean", + "description": "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n" + }, + "emiEligible": { + "type": "boolean", + "description": "This field indicates if the card is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN. In some cases, this field may be absent if we do not receive accurate information from the network source.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).In case the input is not the full intrument (PAN or TOKEN), this field may be truncated.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + ], + "tags": [ + "Tokenize" + ], + "operationId": "tokenize", + "x-devcenter-metaData": { + "categoryTag": "Token_Management", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/all/rest/tms-developer/intro.html", + "mleForRequest": "mandatory" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "Returns the responses from the orchestrated API requests.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally-unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "properties": { + "responses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resource": { + "type": "string", + "description": "TMS token type associated with the response.\n\nPossible Values:\n- customer\n- paymentInstrument\n- instrumentIdentifier\n- shippingAddress\n- tokenizedCard\n", + "example": "customer" + }, + "httpStatus": { + "type": "integer", + "format": "int32", + "description": "Http status associated with the response.\n", + "example": 201 + }, + "id": { + "type": "string", + "description": "TMS token id associated with the response.\n", + "example": "351A67733325454AE0633F36CF0A9420" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n - forbidden\n - notFound\n - instrumentIdentifierDeletionError\n - tokenIdConflict\n - conflict\n - notAvailable\n - serverError\n - notAttempted\n\nA \"notAttempted\" error type is returned when the request cannot be processed because it depends on the existence of another token that does not exist. For example, creating a shipping address token is not attempted if the required customer token is missing.\n", + "example": "notAttempted" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type.", + "example": "Creation not attempted due to customer token creation failure" + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error.", + "example": "address1" + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error.", + "example": "billTo" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request: e.g. A required header value could be missing.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error." + } + } + } + } + } + } + } + } + }, + "examples": { + "Invalid Customer request body": { + "errors": [ + { + "type": "invalidRequest", + "message": "Invalid HTTP Body" + } + ] + } + } + }, + "403": { + "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted" + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - notFound\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - internalError\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Create Complete Customer & Network Token using a Card", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "customer", + "shippingAddress", + "paymentInstrument", + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "customer": { + "buyerInformation": { + "merchantCustomerID": "Your customer identifier", + "email": "test@cybs.com" + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "merchantDefinedInformation": [ + { + "name": "data1", + "value": "Your customer data" + } + ] + }, + "shippingAddress": { + "default": "true", + "shipTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "paymentInstrument": { + "default": "true", + "card": { + "expirationMonth": "12", + "expirationYear": "2031", + "type": "001" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" + } + } + } + } + }, + "example1": { + "summary": "Create Customer Payment Instrument & Network Token using a Card", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "paymentInstrument", + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "customer": { + "id": "" + }, + "paymentInstrument": { + "default": "true", + "card": { + "expirationMonth": "12", + "expirationYear": "2031", + "type": "001" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" + } + } + } + } + }, + "example2": { + "summary": "Create Instrument Identifier & Network Token using a Card", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943123116478", + "expirationMonth": "12", + "expirationYear": "2026" + } + } + } + } + }, + "example3": { + "summary": "Create Complete Customer using a Transient Token", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "customer", + "shippingAddress", + "paymentInstrument", + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "transientTokenJwt": "", + "customer": { + "buyerInformation": { + "merchantCustomerID": "Your customer identifier", + "email": "test@cybs.com" + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "merchantDefinedInformation": [ + { + "name": "data1", + "value": "Your customer data" + } + ] + }, + "shippingAddress": { + "default": "true", + "shipTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + }, + "paymentInstrument": { + "default": "true", + "card": { + "expirationMonth": "12", + "expirationYear": "2031", + "type": "001" + }, + "billTo": { + "firstName": "John", + "lastName": "Doe", + "company": "CyberSource", + "address1": "1 Market St", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "94105", + "country": "US", + "email": "test@cybs.com", + "phoneNumber": "4158880000" + } + } + } + } + }, + "example4": { + "summary": "Create Instrument Identifier using a Transient Token", + "value": { + "processingInformation": { + "actionList": [ + "TOKEN_CREATE" + ], + "actionTokenTypes": [ + "instrumentIdentifier" + ] + }, + "tokenInformation": { + "transientTokenJwt": "" + } + } + } + } + } + }, + "/tms/v2/customers": { + "post": { + "summary": "Create a Customer", + "description": "| | | |\n| --- | --- | --- |\n|**Customers**
A Customer represents your tokenized customer information.
You should associate the Customer Id with the customer account on your systems.
A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.

**Creating a Customer**
It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
The Customer will be created with a Payment Instrument and Shipping Address.
You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
In Europe: You should perform Payer Authentication alongside the Authorization.|      |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).
For more information about Payment Network Tokens see the Developer Guide.

**Payments with Customers**
To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).
To perform a payment with a particular Payment Instrument or Shipping Address
specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).\nThe availability of API features for a merchant may depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.\n", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The Id of a profile containing user specific TMS configuration.", + "required": false, + "type": "string", + "minLength": 36, + "maxLength": 36, + "x-hide-field": true + }, + { + "name": "postCustomerRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Payment Instruments.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" + } + } + }, + "shippingAddress": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customers Shipping Addresses.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/shipping-addresses" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Customer Token." + }, + "objectInformation": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Name or title of the customer.\n", + "maxLength": 60 + }, + "comment": { + "type": "string", + "description": "Comments that you can make about the customer.\n", + "maxLength": 150 + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerID": { + "type": "string", + "description": "Your identifier for the customer.\n", + "maxLength": 100 + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's primary email address, including the full domain name.\n" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Client-generated order reference or tracking number.\n", + "maxLength": 50 + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "Object containing the custom data that the merchant defines.\n", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The number you assign as the name for your merchant-defined data or secure field. Possible Values are data1 to data4 and sensitive1 to sensitive4\n\nFor example, to set the name for merchant-defined data 2 field, you would reference merchantDefinedInformation[x].name as data2\nPossible Values:\n- data1\n- data2\n- data3\n- data4\n- sensitive1\n- sensitive2\n- sensitive3\n- sensitive4\n" + }, + "value": { + "type": "string", + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event it is discovered a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account will immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n", + "maxLength": 100 + } + } + } + }, + "defaultPaymentInstrument": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Id of the Customers default Payment Instrument\n" + } + } + }, + "defaultShippingAddress": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Id of the Customers default Shipping Address\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Customer.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Customer.\n", + "properties": { + "defaultPaymentInstrument": { + "readOnly": true, + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Payment Instrument.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3/payment-instruments" + } + } + }, + "customer": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Customer.\n", + "example": "/tms/v2/customers/D9F340DD3DB9C276E053A2598D0A41A3" + } + } + } + } + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "The Id of the Payment Instrument Token." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "paymentInstrument", + "description": "The type.\n\nPossible Values:\n- paymentInstrument\n" + }, + "default": { + "type": "boolean", + "description": "Flag that indicates whether customer payment instrument is the dafault.\nPossible Values:\n - `true`: Payment instrument is customer's default.\n - `false`: Payment instrument is not customer's default.\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of Payment Instrument.\nPossible Values:\n- cardHash\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 18, + "description": "Account type.\n\nPossible Values:\n - checking : C\n - general ledger : G This value is supported only on Wells Fargo ACH\n - savings : S (U.S. dollars only)\n - corporate checking : X (U.S. dollars only)\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "Value that indicates the card type. Possible Values v2 : v1:\n * 001 : visa\n * 002 : mastercard - Eurocard\u2014European regional brand of Mastercard\n * 003 : american express\n * 004 : discover\n * 005 : diners club\n * 006 : carte blanche\n * 007 : jcb\n * 008 : optima\n * 011 : twinpay credit\n * 012 : twinpay debit\n * 013 : walmart\n * 014 : enRoute\n * 015 : lowes consumer\n * 016 : home depot consumer\n * 017 : mbna\n * 018 : dicks sportswear\n * 019 : casual corner\n * 020 : sears\n * 021 : jal\n * 023 : disney\n * 024 : maestro uk domestic\n * 025 : sams club consumer\n * 026 : sams club business\n * 028 : bill me later\n * 029 : bebe\n * 030 : restoration hardware\n * 031 : delta online \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * 032 : solo\n * 033 : visa electron\n * 034 : dankort\n * 035 : laser\n * 036 : carte bleue \u2014 formerly Cartes Bancaires\n * 037 : carta si\n * 038 : pinless debit\n * 039 : encoded account\n * 040 : uatp\n * 041 : household\n * 042 : maestro international\n * 043 : ge money uk\n * 044 : korean cards\n * 045 : style\n * 046 : jcrew\n * 047 : payease china processing ewallet\n * 048 : payease china processing bank transfer\n * 049 : meijer private label\n * 050 : hipercard \u2014 supported only by the Comercio Latino processor.\n * 051 : aura \u2014 supported only by the Comercio Latino processor.\n * 052 : redecard\n * 054 : elo \u2014 supported only by the Comercio Latino processor.\n * 055 : capital one private label\n * 056 : synchrony private label\n * 057 : costco private label\n * 060 : mada\n * 062 : china union pay\n * 063 : falabella private label\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`.\nPossible Values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "'Payment Instrument was created / updated as part of a pinless debit transaction.'\n" + }, + "hash": { + "type": "string", + "minLength": 32, + "maxLength": 34, + "readOnly": true, + "description": "Hash value representing the card.\n" + }, + "tokenizedInformation": { + "type": "object", + "properties": { + "requestorID": { + "type": "string", + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder's account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider's database.\n\n**Note** This field is supported only through **VisaNet** and **FDC Nashville Global**.\n" + }, + "transactionType": { + "type": "string", + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer's mobile device provided the token data.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "maxLength": 9, + "description": "Company's tax identifier. This is only used for eCheck service.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n# For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "dateOfBirth": { + "type": "string", + "format": "date", + "example": "1960-12-30", + "description": "Date of birth of the customer. Format: YYYY-MM-DD\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type.\n" + }, + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible Values:\n - driver license\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "description": "The State or province where the customer's driver's license was issued.\n\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n", + "maxLength": 20 + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer's first name. This name must be the same as the name on the card.\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer's last name. This name must be the same as the name on the card.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer's company.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card billing street address as it appears on the credit card issuer's records.\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "Payment card billing city.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 20, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\n**Example** `12345-6789`\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer's phone number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "title": "tmsPaymentInstrumentProcessingInfo", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\n# For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "title": "TmsMerchantInformation", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "description": "Alternate contact information for your business,such as an email address or URL.\nThis value might be displayed on the cardholder's statement.\nWhen you do not include this value in your capture or credit request, the merchant URL from your CyberSource account is used.\nImportant This value must consist of English characters\n", + "maxLength": 13 + } + } + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "minLength": 12, + "maxLength": 32, + "description": "The Id of the Instrument Identifier linked to the Payment Instrument.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "readOnly": true, + "description": "The creator of the Payment Instrument.\n" + } + } + }, + "_embedded": { + "type": "object", + "readOnly": true, + "description": "Additional resources for the Payment Instrument.\n", + "properties": { + "instrumentIdentifier": { + "readOnly": true, + "title": "tmsEmbeddedInstrumentIdentifier", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifier.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111" + } + } + }, + "paymentInstruments": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Instrument Identifiers Payment Instruments.\n", + "example": "tms/v1/instrumentidentifiers/7010000000016241111/paymentinstruments" + } + } + } + } + }, + "id": { + "type": "string", + "description": "The Id of the Instrument Identifier Token.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "The type.\n\nPossible Values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the card number.\nPossible Values:\n- ACTIVE\n- CLOSED : The account has been closed.\n" + }, + "type": { + "type": "string", + "description": "The type of Instrument Identifier.\nPossible Values:\n- enrollable card\n- enrollable token\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- CONTACTLESS_TAP\n" + }, + "tokenProvisioningInformation": { + "type": "object", + "properties": { + "consumerConsentObtained": { + "type": "boolean", + "description": "Flag that indicates whether the user consented to the tokenization of their credentials. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has consented to tokenization of their credentials.\n- `false`: Consumer has not consented to tokenization of their credentials.\n" + }, + "multiFactorAuthenticated": { + "type": "boolean", + "description": "Flag that indicates whether AFA (Additional Factor of Authentication) for the PAN was completed. Required for card network tokenization in certain markets, such as India.\nPossible Values:\n- `true`: Consumer has been authenticated by the issuer.\n- `false`: Consumer has not been authenticated by the issuer.\n" + } + } + }, + "card": { + "type": "object", + "description": "The expirationMonth, expirationYear and securityCode is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Code. \nThis value is sent to the issuer to support the approval of a network token provision.\nIt is not persisted against the Instrument Identifier.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "required": [ + "emvTags" + ], + "properties": { + "emvTags": { + "type": "array", + "minItems": 1, + "maxItems": 50, + "items": { + "type": "object", + "required": [ + "tag", + "value", + "source" + ], + "properties": { + "tag": { + "type": "string", + "minLength": 1, + "maxLength": 10, + "pattern": "^[0-9A-Fa-f]{1,10}$", + "description": "EMV tag, 1-10 hex characters." + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "EMV tag value, 1-64 characters." + }, + "source": { + "type": "string", + "description": "Source of the tag.\n\nPossible Values:\n - CARD\n - TERMINAL\n" + } + }, + "example": { + "tag": "5A", + "value": "4111111111111111", + "source": "CARD" + } + } + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "routingNumber": { + "type": "string", + "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + } + } + }, + "tokenizedCard": { + "title": "tmsv2TokenizedCard", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The Id of the Tokenized Card.\n" + }, + "object": { + "type": "string", + "readOnly": true, + "example": "tokenizedCard", + "description": "The type.\nPossible Values:\n- tokenizedCard\n" + }, + "accountReferenceId": { + "type": "string", + "description": "An identifier provided by the issuer for the account.\n" + }, + "consumerId": { + "type": "string", + "maxLength": 36, + "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS." + }, + "createInstrumentIdentifier": { + "type": "boolean", + "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n" + }, + "source": { + "type": "string", + "description": "Source of the card details.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n" + }, + "reason": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Issuers state for the network token\nPossible Values:\n- INVALID_REQUEST : The network token provision request contained invalid data.\n- CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified.\n- CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization.\n- CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization.\n- DECLINED : Card can currently not be used with issuer for tokenization.\n- SERVICE_UNAVAILABLE : The network token service was unavailable or timed out.\n- SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.\n" + }, + "number": { + "type": "string", + "readOnly": true, + "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n" + }, + "expirationMonth": { + "type": "string", + "readOnly": true, + "description": "Two-digit month in which the network token expires.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "readOnly": true, + "description": "Four-digit year in which the network token expires.\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n" + }, + "cryptogram": { + "type": "string", + "readOnly": true, + "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n", + "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM=" + }, + "securityCode": { + "type": "string", + "readOnly": true, + "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n", + "example": "4523" + }, + "eci": { + "type": "string", + "readOnly": true, + "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "maxLength": 11, + "description": "11-digit identifier that uniquely identifies the Token Requestor.\n" + }, + "enrollmentId": { + "type": "string", + "readOnly": true, + "description": "Unique id to identify this PAN/ enrollment.\n" + }, + "tokenReferenceId": { + "type": "string", + "readOnly": true, + "description": "Unique ID for netwrok token.\n" + }, + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "description": "Payment account reference.\n" + }, + "card": { + "type": "object", + "description": "Card object used to create a network token\n", + "properties": { + "number": { + "type": "string", + "minLength": 12, + "maxLength": 19, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n" + }, + "type": { + "type": "string", + "description": "The type of card (Card Network).\nPossible Values:\n- 001: visa\n" + }, + "suffix": { + "type": "string", + "readOnly": true, + "description": "The customer's latest payment card number suffix.\n" + }, + "issueDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card issuance date. XML date format: YYYY-MM-DD.", + "example": "2030-12-15" + }, + "activationDate": { + "type": "string", + "readOnly": true, + "format": "date", + "description": "Card activation date. XML date format: YYYY-MM-DD", + "example": "2030-12-20" + }, + "expirationPrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the expiration date is printed on the card.", + "example": true + }, + "securityCodePrinted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the Card Verification Number is printed on the card.", + "example": true + }, + "termsAndConditions": { + "type": "object", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer Card Terms and Conditions url." + } + } + } + } + }, + "passcode": { + "type": "object", + "description": "Passcode by issuer for ID&V.\n", + "properties": { + "value": { + "type": "string", + "description": "OTP generated at issuer.\n" + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "description": "Metadata associated with the tokenized card.\n", + "properties": { + "cardArt": { + "title": "TmsCardArt", + "description": "Card art associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "foregroundColor": { + "description": "Card foreground color.\n", + "type": "string", + "readOnly": true + }, + "combinedAsset": { + "description": "Combined card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n" + } + } + } + } + } + } + }, + "brandLogoAsset": { + "description": "Brand logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n" + } + } + } + } + } + } + }, + "issuerLogoAsset": { + "description": "Issuer logo card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n" + } + } + } + } + } + } + }, + "iconAsset": { + "description": "Icon card art asset associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asset\n" + }, + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "readOnly": true, + "properties": { + "href": { + "type": "string", + "readOnly": true, + "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n" + } + } + } + } + } + } + } + } + }, + "issuer": { + "description": "Issuer associated with the tokenized card.\n", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Issuer name.\n", + "type": "string", + "readOnly": true + }, + "shortDescription": { + "description": "Short description of the card.\n", + "type": "string", + "readOnly": true + }, + "longDescription": { + "description": "Long description of the card.\n", + "type": "string", + "readOnly": true + }, + "email": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service email address." + }, + "phoneNumber": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service phone number." + }, + "url": { + "type": "string", + "readOnly": true, + "description": "Issuer customer service url." + } + } + } + } + } + } + }, + "issuer": { + "type": "object", + "readOnly": true, + "properties": { + "paymentAccountReference": { + "type": "string", + "readOnly": true, + "maxLength": 32, + "description": "This reference number serves as a link to the cardholder account and to all transactions for that account.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "title": "tmsAuthorizationOptions", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original authorization.\n" + } + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "description": "This information is sent to the issuer as part of network token enrollment and is not stored under the Instrument Identifier.\n", "properties": { "address1": { "type": "string", @@ -48927,7 +53046,8 @@ "operationId": "postCustomer", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -49362,6 +53482,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -51120,6 +55241,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -52875,6 +56997,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -53880,7 +58003,8 @@ "operationId": "patchCustomer", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-tkn/tms-cust-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -54324,6 +58448,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -56255,7 +60380,8 @@ "operationId": "postCustomerShippingAddress", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -58030,7 +62156,8 @@ "operationId": "patchCustomersShippingAddress", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ship-tkn/tms-ship-addr-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -59303,6 +63430,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -60187,7 +64315,8 @@ "operationId": "postCustomerPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -60491,6 +64620,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -62212,6 +66342,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -63748,6 +67879,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -65247,6 +69379,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -66131,7 +70264,8 @@ "operationId": "patchCustomersPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-cust-pi-tkn/tms-cust-pi-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -66431,6 +70565,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -68473,6 +72608,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -69357,7 +73493,8 @@ "operationId": "postPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -69643,6 +73780,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -71221,6 +75359,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -72718,6 +76857,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -73602,7 +77742,8 @@ "operationId": "patchPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-pi-tkn/tms-pi-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -73902,6 +78043,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -76389,7 +80531,8 @@ "operationId": "postInstrumentIdentifier", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-create-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-create-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -80528,7 +84671,8 @@ "operationId": "patchInstrumentIdentifier", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-update-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-ii-tkn/tms-ii-tkn-update-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -82600,6 +86744,7 @@ }, "merchantInformation": { "type": "object", + "title": "TmsMerchantInformation", "properties": { "merchantDescriptor": { "type": "object", @@ -84666,7 +88811,8 @@ "operationId": "postInstrumentIdentifierEnrollment", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-partner-ii-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-partner-ii-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -85447,7 +89593,8 @@ "operationId": "postTokenizedCard", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-create-cof-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-card-create-cof-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -87321,7 +91468,154 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted" + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The Id may not exist or was entered incorrectly.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - notFound\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "409": { + "description": "Conflict. The token is linked to a Payment Instrument.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - instrumentIdentifierDeletionError\n - tokenIdConflict\n - conflict\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "conflict", + "message": "Action cannot be performed as the PaymentInstrument is the customers default" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" }, "message": { "type": "string", @@ -87337,15 +91631,15 @@ "application/json": { "errors": [ { - "type": "forbidden", - "message": "Request not permitted" + "type": "notAvailable", + "message": "Token not available." } ] } } }, - "404": { - "description": "Token Not Found. The Id may not exist or was entered incorrectly.", + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87387,14 +91681,14 @@ "errors": [ { "type": "notFound", - "message": "Token not found" + "message": "Profile not found" } ] } } }, - "409": { - "description": "Conflict. The token is linked to a Payment Instrument.", + "500": { + "description": "Unexpected error.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87405,6 +91699,16 @@ "type": "string" } }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, "schema": { "type": "object", "readOnly": true, @@ -87419,12 +91723,180 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - instrumentIdentifierDeletionError\n - tokenIdConflict\n - conflict\n" + "description": "The type of error.\n\nPossible Values:\n - internalError\n" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed message related to the type." + } + } + } + } + } + } + } + } + } + }, + "/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations": { + "post": { + "summary": "Simulate Issuer Life Cycle Management Events", + "description": "**Lifecycle Management Events**
Simulates an issuer life cycle manegement event for updates on the tokenized card.\nThe events that can be simulated are:\n- Token status changes (e.g. active, suspended, deleted)\n- Updates to the underlying card, including card art changes, expiration date changes, and card number suffix.\n**Note:** This is only available in CAS environment.\n", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "required": true, + "type": "string", + "description": "The Id of a profile containing user specific TMS configuration.", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenizedCardId", + "in": "path", + "description": "The Id of a tokenized card.", + "required": true, + "type": "string", + "minLength": 12, + "maxLength": 32 + }, + { + "name": "postIssuerLifeCycleSimulationRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "description": "Represents the Issuer LifeCycle Event Simulation for a Tokenized Card.\n", + "properties": { + "state": { + "type": "string", + "description": "The new state of the Tokenized Card.\nPossible Values:\n- ACTIVE\n- SUSPENDED\n- DELETED\n" + }, + "card": { + "type": "object", + "properties": { + "last4": { + "type": "string", + "maxLength": 4, + "description": "The new last 4 digits of the card number associated to the Tokenized Card.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "The new two-digit month of the card associated to the Tokenized Card.\nFormat: `MM`.\nPossible Values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "The new four-digit year of the card associated to the Tokenized Card.\nFormat: `YYYY`.\n" + } + } + }, + "metadata": { + "type": "object", + "properties": { + "cardArt": { + "type": "object", + "properties": { + "combinedAsset": { + "type": "object", + "properties": { + "update": { + "type": "string", + "description": "Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card.\n" + } + } + } + } + } + } + } + } + } + } + ], + "tags": [ + "Tokenized Card" + ], + "operationId": "postIssuerLifeCycleSimulation", + "x-devcenter-metaData": { + "categoryTag": "Token_Management", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-intro/tms-net-tkn-card-simulate-issuer-life-cycle-event-intro.html" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "204": { + "description": "The request is fulfilled but does not need to return a body", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + } + }, + "400": { + "description": "Bad Request: e.g. A required header value could be missing.", + "headers": { + "v-c-correlation-id": { + "description": "The mandatory correlation Id passed by upstream (calling) system.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique Id associated with your request.", + "type": "string" + } + }, + "schema": { + "type": "object", + "readOnly": true, + "properties": { + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of error.\n\nPossible Values:\n - invalidHeaders\n - missingHeaders\n - invalidFields\n - missingFields\n - unsupportedPaymentMethodModification\n - invalidCombination\n" }, "message": { "type": "string", "readOnly": true, "description": "The detailed message related to the type." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that caused the error." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the field that caused the error." + } + } + } } } } @@ -87432,18 +91904,18 @@ } }, "examples": { - "application/json": { + "Invalid Customer request body": { "errors": [ { - "type": "conflict", - "message": "Action cannot be performed as the PaymentInstrument is the customers default" + "type": "invalidRequest", + "message": "Invalid HTTP Body" } ] } } }, - "410": { - "description": "Token Not Available. The token has been deleted.", + "403": { + "description": "Forbidden: e.g. The profile might not have permission to perform the operation.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87468,7 +91940,7 @@ "type": { "type": "string", "readOnly": true, - "description": "The type of error.\n\nPossible Values:\n - notAvailable\n" + "description": "The type of error.\n\nPossible Values:\n - forbidden\n - declined\n" }, "message": { "type": "string", @@ -87484,15 +91956,15 @@ "application/json": { "errors": [ { - "type": "notAvailable", - "message": "Token not available." + "type": "forbidden", + "message": "Request not permitted" } ] } } }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "404": { + "description": "Token Not Found. The Id may not exist or was entered incorrectly.", "headers": { "v-c-correlation-id": { "description": "The mandatory correlation Id passed by upstream (calling) system.", @@ -87534,7 +92006,7 @@ "errors": [ { "type": "notFound", - "message": "Profile not found" + "message": "Token not found" } ] } @@ -87589,6 +92061,36 @@ } } } + }, + "x-example": { + "example0": { + "summary": "Simulate Network Token Status Update", + "value": { + "state": "SUSPENDED" + } + }, + "example1": { + "summary": "Simulate Network Token Card Metadata Update", + "value": { + "card": { + "last4": "9876", + "expirationMonth": "11", + "expirationYear": "2040" + } + } + }, + "example2": { + "summary": "Simulate Network Token Card Art Update", + "value": { + "metadata": { + "cardArt": { + "combinedAsset": { + "update": "true" + } + } + } + } + } } } }, @@ -87853,7 +92355,8 @@ "operationId": "postTokenPaymentCredentials", "x-devcenter-metaData": { "categoryTag": "Token_Management", - "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-partner-retrieve-pay-cred-intro.html" + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/tms/developer/ctv/rest/tms/tms-net-tkn-indirect/tms-net-tkn-partner-retrieve-pay-cred-intro.html", + "mleForRequest": "optional" }, "consumes": [ "application/json;charset=utf-8" @@ -101675,43 +106178,6 @@ "schema": { "type": "object", "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "comments": { - "type": "string", - "maxLength": 255, - "description": "Brief description of the order or any comment you wish to add to the order.\n" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" - } - } - }, - "applicationName": { - "type": "string", - "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n" - }, - "applicationVersion": { - "type": "string", - "description": "Version of the CyberSource application or integration used for a transaction.\n" - }, - "applicationUser": { - "type": "string", - "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n" - } - } - }, "planInformation": { "type": "object", "required": [ @@ -103422,41 +107888,9 @@ "type": "object", "properties": { "code": { - "description": "> Deprecated: This field is ignored.\n\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", "type": "string", "maxLength": 50 - }, - "comments": { - "description": "> Deprecated: This field is ignored.\n\nBrief description of the order or any comment you wish to add to the order.\n", - "type": "string", - "maxLength": 255 - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - }, - "solutionId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - } - } - }, - "applicationName": { - "description": "> Deprecated: This field is ignored.\n\nThe name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n", - "type": "string" - }, - "applicationVersion": { - "description": "> Deprecated: This field is ignored.\n\nVersion of the CyberSource application or integration used for a transaction.\n", - "type": "string" - }, - "applicationUser": { - "description": "> Deprecated: This field is ignored.\n\nThe entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n", - "type": "string" } } }, @@ -103607,6 +108041,9 @@ "customer": { "id": "C24F5921EB870D99E053AF598E0A4105" } + }, + "clientReferenceInformation": { + "code": "TC501713" } } } @@ -103715,6 +108152,16 @@ "description": "Subscription Status:\n - `PENDING`\n - `ACTIVE`\n - `FAILED`\n" } } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } } }, "example": { @@ -103820,6 +108267,9 @@ "summary": "Create Subscription", "sample-name": "Create Subscription", "value": { + "clientReferenceInformation": { + "code": "TC501713" + }, "subscriptionInformation": { "planId": "6868912495476705603955", "name": "Subscription with PlanId", @@ -103838,13 +108288,7 @@ "sample-name": "(deprecated) Create Subscription with Authorization", "value": { "clientReferenceInformation": { - "code": "TC501713", - "partner": { - "developerId": "ABCD1234", - "solutionId": "GEF1234" - }, - "applicationName": "CYBS-SDK", - "applicationVersion": "v1" + "code": "TC501713" }, "processingInformation": { "commerceIndicator": "recurring", @@ -104116,6 +108560,16 @@ } } }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } + }, "paymentInformation": { "type": "object", "properties": { @@ -104475,18 +108929,28 @@ } } }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } + }, "reactivationInformation": { "type": "object", "properties": { - "skippedPaymentsCount": { + "missedPaymentsCount": { "type": "string", "maxLength": 10, "description": "Number of payments that should have occurred while the subscription was in a suspended status.\n" }, - "skippedPaymentsTotalAmount": { + "missedPaymentsTotalAmount": { "type": "string", "maxLength": 19, - "description": "Total amount that will be charged upon reactivation if `processSkippedPayments` is set to `true`.\n" + "description": "Total amount that will be charged upon reactivation if `processMissedPayments` is set to `true`.\n" } } } @@ -104616,41 +109080,9 @@ "type": "object", "properties": { "code": { - "description": "> Deprecated: This field is ignored.\n\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", "type": "string", "maxLength": 50 - }, - "comments": { - "description": "> Deprecated: This field is ignored.\n\nBrief description of the order or any comment you wish to add to the order.\n", - "type": "string", - "maxLength": 255 - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - }, - "solutionId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - } - } - }, - "applicationName": { - "description": "> Deprecated: This field is ignored.\n\nThe name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n", - "type": "string" - }, - "applicationVersion": { - "description": "> Deprecated: This field is ignored.\n\nVersion of the CyberSource application or integration used for a transaction.\n", - "type": "string" - }, - "applicationUser": { - "description": "> Deprecated: This field is ignored.\n\nThe entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n", - "type": "string" } } }, @@ -105109,7 +109541,7 @@ "/rbs/v1/subscriptions/{id}/suspend": { "post": { "summary": "Suspend a Subscription", - "description": "Suspend a Subscription", + "description": "Suspend a Subscription\n", "tags": [ "Subscriptions" ], @@ -105277,8 +109709,8 @@ }, "/rbs/v1/subscriptions/{id}/activate": { "post": { - "summary": "Activate a Subscription", - "description": "Activate a `SUSPENDED` Subscription\n", + "summary": "Reactivating a Suspended Subscription", + "description": "# Reactivating a Suspended Subscription\n\nYou can reactivate a suspended subscription for the next billing cycle. You cannot reactivate a canceled or completed subscription.\n\nYou can specify whether you want to process missed payments for the period during which the subscription was suspended using the `processMissedPayments` query parameter by setting it to true or false. \nIf no value is specified, the system will default to `true`.\n\n**Important:** The \"processMissedPayments\" query parameter is only effective when the Ask each time before reactivating option is selected in the reactivation settings. If any other option is chosen, the value provided in the request will be ignored by the system. For more information, see the [Recurring Billing User Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/user/all/rest/recurring-billing-user/recurring-billing-user-about-guide.html).\n\nYou can check how many payments were missed and the total amount by retrieving the subscription details, where you will find the `reactivationInformation` object. See: [Retrieving a Subscription](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-dev/recur-bill-subscriptions/recur-bill-getting-a-subscription.html).\n", "tags": [ "Subscriptions" ], @@ -105306,10 +109738,10 @@ "description": "Subscription Id" }, { - "name": "processSkippedPayments", + "name": "processMissedPayments", "in": "query", "type": "boolean", - "description": "Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true.", + "description": "Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true.\nWhen any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored.\n", "required": false, "default": true } @@ -106073,41 +110505,9 @@ "type": "object", "properties": { "code": { - "description": "> Deprecated: This field is ignored.\n\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", "type": "string", "maxLength": 50 - }, - "comments": { - "description": "> Deprecated: This field is ignored.\n\nBrief description of the order or any comment you wish to add to the order.\n", - "type": "string", - "maxLength": 255 - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - }, - "solutionId": { - "description": "> This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription.\n\nIdentifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n", - "type": "string", - "maxLength": 8 - } - } - }, - "applicationName": { - "description": "> Deprecated: This field is ignored.\n\nThe name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n", - "type": "string" - }, - "applicationVersion": { - "description": "> Deprecated: This field is ignored.\n\nVersion of the CyberSource application or integration used for a transaction.\n", - "type": "string" - }, - "applicationUser": { - "description": "> Deprecated: This field is ignored.\n\nThe entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n", - "type": "string" } } }, @@ -106230,13 +110630,7 @@ }, "example": { "clientReferenceInformation": { - "code": "FollowOn from 7216512479796378604957", - "partner": { - "developerId": "ABCD1234", - "solutionId": "GEF1234" - }, - "applicationName": "CYBS-SDK", - "applicationVersion": "v1" + "code": "FollowOn from 7216512479796378604957" }, "processingInformation": { "commerceIndicator": "recurring", @@ -106358,6 +110752,16 @@ "description": "Subscription Status:\n - `PENDING`\n - `ACTIVE`\n - `FAILED`\n" } } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "description": "\nMerchant-generated order reference or tracking number. It is recommended that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\n#### Used by\n**Authorization**\nRequired field.\n\n#### PIN Debit\nRequests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being\nreversed.\n\nRequired field for all PIN Debit requests (purchase, credit, and reversal).\n\n#### FDC Nashville Global\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n", + "type": "string", + "maxLength": 50 + } + } } }, "example": { @@ -106464,13 +110868,7 @@ "sample-name": "Create Follow-On Subscription", "value": { "clientReferenceInformation": { - "code": "FollowOn from 7216512479796378604957", - "partner": { - "developerId": "ABCD1234", - "solutionId": "GEF1234" - }, - "applicationName": "CYBS-SDK", - "applicationVersion": "v1" + "code": "FollowOn from 7216512479796378604957" }, "processingInformation": { "commerceIndicator": "recurring", @@ -134847,6 +139245,24 @@ } } } + }, + "batchUpload": { + "type": "object", + "properties": { + "subscriptionInformation": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "selfServiceability": { + "type": "string", + "default": "NOT_SELF_SERVICEABLE", + "description": "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY" + } + } + } + } } } }, @@ -136622,26 +141038,159 @@ "type": "string" } } - } - } - }, - "recurringBilling": { - "type": "object", - "properties": { - "subscriptionStatus": { + } + } + }, + "recurringBilling": { + "type": "object", + "properties": { + "subscriptionStatus": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + }, + "configurationStatus": { + "type": "object", + "properties": { + "configurationId": { + "type": "string", + "description": "This is NOT for MVP" + }, + "version": { + "type": "string" + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + } + } + }, + "cybsReadyTerminal": { + "type": "object", + "properties": { + "subscriptionStatus": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + }, + "configurationStatus": { "type": "object", "properties": { + "configurationId": { + "type": "string", + "description": "This is NOT for MVP" + }, + "version": { + "type": "string" + }, "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, "status": { "type": "string", - "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" }, "reason": { "type": "string", - "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" }, "details": { "type": "array", @@ -136665,28 +141214,26 @@ "type": "string" } } - }, - "configurationStatus": { + } + } + }, + "paymentOrchestration": { + "type": "object", + "properties": { + "subscriptionStatus": { "type": "object", "properties": { - "configurationId": { - "type": "string", - "description": "This is NOT for MVP" - }, - "version": { - "type": "string" - }, "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, "status": { "type": "string", - "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" }, "reason": { "type": "string", - "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" }, "details": { "type": "array", @@ -136713,7 +141260,7 @@ } } }, - "cybsReadyTerminal": { + "payouts": { "type": "object", "properties": { "subscriptionStatus": { @@ -136801,7 +141348,7 @@ } } }, - "paymentOrchestration": { + "payByLink": { "type": "object", "properties": { "subscriptionStatus": { @@ -136844,7 +141391,7 @@ } } }, - "payouts": { + "unifiedCheckout": { "type": "object", "properties": { "subscriptionStatus": { @@ -136884,55 +141431,10 @@ "type": "string" } } - }, - "configurationStatus": { - "type": "object", - "properties": { - "configurationId": { - "type": "string", - "description": "This is NOT for MVP" - }, - "version": { - "type": "string" - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" - } - }, - "additionalProperties": { - "type": "string" - } - } - }, - "message": { - "type": "string" - } - } } } }, - "payByLink": { + "receivablesManager": { "type": "object", "properties": { "subscriptionStatus": { @@ -136975,7 +141477,7 @@ } } }, - "unifiedCheckout": { + "serviceFee": { "type": "object", "properties": { "subscriptionStatus": { @@ -137015,26 +141517,28 @@ "type": "string" } } - } - } - }, - "receivablesManager": { - "type": "object", - "properties": { - "subscriptionStatus": { + }, + "configurationStatus": { "type": "object", "properties": { + "configurationId": { + "type": "string", + "description": "This is NOT for MVP" + }, + "version": { + "type": "string" + }, "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, "status": { "type": "string", - "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" }, "reason": { "type": "string", - "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" }, "details": { "type": "array", @@ -137061,7 +141565,7 @@ } } }, - "serviceFee": { + "batchUpload": { "type": "object", "properties": { "subscriptionStatus": { @@ -137101,51 +141605,6 @@ "type": "string" } } - }, - "configurationStatus": { - "type": "object", - "properties": { - "configurationId": { - "type": "string", - "description": "This is NOT for MVP" - }, - "version": { - "type": "string" - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "Possible values:\n- SUCCESS\n- PARTIAL\n- PENDING\n- NOT_SETUP" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- PENDING_PROVISIONING_PROCESS\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD\n- NOT_APPLICABLE" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "reason": { - "type": "string", - "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" - } - }, - "additionalProperties": { - "type": "string" - } - } - }, - "message": { - "type": "string" - } - } } } } @@ -145273,6 +149732,24 @@ } } } + }, + "batchUpload": { + "type": "object", + "properties": { + "subscriptionInformation": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "selfServiceability": { + "type": "string", + "default": "NOT_SELF_SERVICEABLE", + "description": "Indicates if the organization can enable this product using self service. \nPossible values:\n- SELF_SERVICEABLE\n- NOT_SELF_SERVICEABLE\n- SELF_SERVICE_ONLY" + } + } + } + } } } }, @@ -147440,6 +151917,49 @@ } } } + }, + "batchUpload": { + "type": "object", + "properties": { + "subscriptionStatus": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "Possible values:\n- SUCCESS\n- FAILURE\n- PARTIAL\n- PENDING" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- DEPENDENT_PRODUCT_NOT_CONTRACTED\n- DEPENDENT_FEATURE_NOT_CHOSEN\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "reason": { + "type": "string", + "description": "Possible values:\n- MISSING_DATA\n- INVALID_DATA\n- DUPLICATE_FIELD" + } + }, + "additionalProperties": { + "type": "string" + } + } + }, + "message": { + "type": "string" + } + } + } + } } } }, @@ -151507,7 +156027,7 @@ "properties": { "clientVersion": { "type": "string", - "example": "0.25", + "example": "0.32", "maxLength": 60, "description": "Specify the version of Unified Checkout that you want to use." }, @@ -151536,7 +156056,7 @@ "items": { "type": "string" }, - "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - AFTERPAY

\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE)\n - DragonPay (PH)\n - iDEAL (NL)\n - Multibanco (PT)\n - MyBank (IT, BE, PT, ES)\n - Przelewy24|P24 (PL)\n - Tink Pay By Bank (GB)\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" + "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE

\n\nUnified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods:\n - AFTERPAY

\n\nUnified Checkout supports the following Online Bank Transfer payment methods:\n - Bancontact (BE)\n - DragonPay (PH)\n - iDEAL (NL)\n - Multibanco (PT)\n - MyBank (IT, BE, PT, ES)\n - Przelewy24|P24 (PL)\n - Tink Pay By Bank (GB)

\n\n Unified Checkout supports the following Post-Pay Reference payment methods:\n - Konbini (JP)

\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY

\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

\n\n**Managing Google Pay Authentication Types**\nWhen you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

\n\n**Managing Google Pay Authentication Types**\nWhere Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". \n\nThis is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\".\n - UAE\n - Argentina\n - Brazil\n - Chile\n - Colombia\n - Kuwait\n - Mexico\n - Peru\n - Qatar\n - Saudi Arabia\n - Ukraine\n - South Africa

\n\nIf false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry.\n" }, "country": { "type": "string", @@ -151549,6 +156069,11 @@ "example": "en_US", "description": "Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code.\n\nPlease refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html)\n" }, + "buttonType": { + "type": "string", + "example": null, + "description": "Changes the label on the payment button within Unified Checkout .

\n\nPossible values:\n- ADD_CARD\n- CARD_PAYMENT\n- CHECKOUT\n- CHECKOUT_AND_CONTINUE\n- DEBIT_CREDIT\n- DONATE\n- PAY\n- PAY_WITH_CARD\n- SAVE_CARD\n- SUBSCRIBE_WITH_CARD

\n\nThis is an optional field,\n" + }, "captureMandate": { "type": "object", "properties": { @@ -151705,6 +156230,23 @@ "type": "string", "example": 10, "description": "This field defines the tax amount applicable to the order.\n" + }, + "taxDetails": { + "type": "object", + "properties": { + "taxId": { + "type": "string", + "example": 1234, + "maxLength": 20, + "description": "This field defines the tax identifier/registration number\n" + }, + "type": { + "type": "string", + "example": "N", + "maxLength": 1, + "description": "This field defines the Tax type code (N=National, S=State, L=Local etc)\n" + } + } } } }, @@ -151971,188 +156513,225 @@ "productCode": { "type": "string", "maxLength": 255, - "example": "electronics" + "example": "electronics", + "description": "Code identifying the product." }, "productName": { "type": "string", "maxLength": 255, - "example": "smartphone" + "example": "smartphone", + "description": "Name of the product." }, "productSku": { "type": "string", "maxLength": 255, - "example": "SKU12345" + "example": "SKU12345", + "description": "Stock Keeping Unit identifier" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 999999999, "default": 1, - "example": 2 + "example": 2, + "description": "Quantity of the product" }, "unitPrice": { "type": "string", "maxLength": 15, - "example": "399.99" + "example": "399.99", + "description": "Price per unit" }, "unitOfMeasure": { "type": "string", "maxLength": 12, - "example": "EA" + "example": "EA", + "description": "Unit of measure (e.g. EA, KG, LB)" }, "totalAmount": { "type": "string", "maxLength": 13, - "example": "799.98" + "example": "799.98", + "description": "Total amount for the line item" }, "taxAmount": { "type": "string", "maxLength": 15, - "example": "64.00" + "example": "64.00", + "description": "Tax amount applied" }, "taxRate": { "type": "string", "maxLength": 7, - "example": "0.88" + "example": "0.88", + "description": "Tax rate applied" }, "taxAppliedAfterDiscount": { "type": "string", "maxLength": 1, - "example": "Y" + "example": "Y", + "description": "Indicates if tax applied after discount" }, "taxStatusIndicator": { "type": "string", "maxLength": 1, - "example": "N" + "example": "N", + "description": "Tax status indicator" }, "taxTypeCode": { "type": "string", "maxLength": 4, - "example": "VAT" + "example": "VAT", + "description": "Tax type code" }, "amountIncludesTax": { "type": "boolean", - "example": false + "example": false, + "description": "Indicates if amount includes tax" }, "typeOfSupply": { "type": "string", "maxLength": 2, - "example": "GS" + "example": "GS", + "description": "Type of supply" }, "commodityCode": { "type": "string", "maxLength": 15, - "example": "123456" + "example": "123456", + "description": "Commodity code" }, "discountAmount": { "type": "string", "maxLength": 13, - "example": "10.00" + "example": "10.00", + "description": "Discount amount applied" }, "discountApplied": { "type": "boolean", - "example": true + "example": true, + "description": "Indicates if discount applied" }, "discountRate": { "type": "string", "maxLength": 6, - "example": "0.05" + "example": "0.05", + "description": "Discount rate applied" }, "invoiceNumber": { "type": "string", "maxLength": 23, - "example": "INV-001" + "example": "INV-001", + "description": "Invoice number for the line item" }, "taxDetails": { "type": "object", "properties": { "type": { "type": "string", - "example": "VAT" + "example": "VAT", + "description": "Type of tax" }, "amount": { "type": "string", "maxLength": 13, - "example": 5.99 + "example": 5.99, + "description": "Tax amount" }, "rate": { "type": "string", "maxLength": 6, - "example": 20 + "example": 20, + "description": "Tax rate" }, "code": { "type": "string", "maxLength": 4, - "example": "VAT" + "example": "VAT", + "description": "Tax code" }, "taxId": { "type": "string", "maxLength": 15, - "example": "TAXID12345" + "example": "TAXID12345", + "description": "Tax Identifier" }, "applied": { "type": "boolean", - "example": true + "example": true, + "description": "Indicates if tax applied" }, "exemptionCode": { "type": "string", "maxLength": 1, - "example": "E" + "example": "E", + "description": "Tax exemption code" } } }, "fulfillmentType": { "type": "string", - "example": "Delivery" + "example": "Delivery", + "description": "Fulfillment type" }, "weight": { "type": "string", "maxLength": 9, - "example": "1.5" + "example": "1.5", + "description": "Weight of the product" }, "weightIdentifier": { "type": "string", "maxLength": 1, - "example": "N" + "example": "N", + "description": "Weight identifier" }, "weightUnit": { "type": "string", "maxLength": 2, - "example": "KG" + "example": "KG", + "description": "Unit of weight of the product" }, "referenceDataCode": { "type": "string", "maxLength": 150, - "example": "REFCODE" + "example": "REFCODE", + "description": "Reference data code" }, "referenceDataNumber": { "type": "string", "maxLength": 30, - "example": "REF123" + "example": "REF123", + "description": "Reference data number" }, "unitTaxAmount": { "type": "string", "maxLength": 15, - "example": "3.20" + "example": "3.20", + "description": "Unit tax amount" }, "productDescription": { "type": "string", "maxLength": 30, - "example": "Latest model smartphone" + "example": "Latest model smartphone", + "description": "Description of the product" }, "giftCardCurrency": { "type": "string", "maxLength": 3, - "example": "USD" + "example": "USD", + "description": "Gift card currency" }, "shippingDestinationTypes": { "type": "string", "maxLength": 50, - "example": "Residential" + "example": "Residential", + "description": "Shipping destination types" }, "gift": { "type": "boolean", - "example": false + "example": false, + "description": "Indicates if item is a gift" }, "passenger": { "type": "object", @@ -152160,46 +156739,71 @@ "type": { "type": "string", "maxLength": 50, - "example": "Residential" + "example": "Residential", + "description": "Passenger type" }, "status": { "type": "string", "maxLength": 32, - "example": "Gold" + "example": "Gold", + "description": "Passenger status" }, "phone": { "type": "string", "maxLength": 15, - "example": "123456789" + "example": "123456789", + "description": "Passenger phone number" }, "firstName": { "type": "string", "maxLength": 60, - "example": "John" + "example": "John", + "description": "Passenger first name" }, "lastName": { "type": "string", "maxLength": 60, - "example": "Doe" + "example": "Doe", + "description": "Passenger last name" }, "id": { "type": "string", "maxLength": 40, - "example": "AIR1234567" + "example": "AIR1234567", + "description": "Passenger ID" }, "email": { "type": "string", "maxLength": 50, - "example": "john.doe@example.com" + "example": "john.doe@example.com", + "description": "Passenger email" }, "nationality": { "type": "string", "maxLength": 2, - "example": "US" + "example": "US", + "description": "Passenger nationality" } } } } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "invoiceNumber": { + "type": "string", + "maxLength": 255, + "example": "electronics", + "description": "Invoice number" + }, + "productDescription": { + "type": "string", + "maxLength": 255, + "example": "electronics", + "description": "Product description" + } + } } } }, @@ -152211,21 +156815,35 @@ "properties": { "cpf": { "type": "string", - "minLength": 11, "maxLength": 11, - "example": "12345678900" + "example": "12345678900", + "description": "CPF Number (Brazil). Must be 11 digits in length.\n" } } }, "merchantCustomerId": { "type": "string", "maxLength": 100, - "example": "M123456767" + "example": "M123456767", + "description": "The Merchant Customer ID\n" }, "companyTaxId": { "type": "string", "maxLength": 9, - "example": "" + "example": "", + "description": "The Company Tax ID\n" + }, + "dateOfBirth": { + "type": "string", + "maxLength": 10, + "example": "12/03/1976", + "description": "The date of birth\n" + }, + "language": { + "type": "string", + "maxLength": 10, + "example": "English", + "description": "The preferred language\n" } } }, @@ -152245,7 +156863,7 @@ "maxLength": 8, "example": "DEV12345" }, - "SolutionId": { + "solutionId": { "type": "string", "maxLength": 8, "example": "SOL1234" @@ -152260,12 +156878,20 @@ "challengeCode": { "type": "string", "maxLength": 2, - "example": "01" + "example": "01", + "description": "The challenge code\n" }, "messageCategory": { "type": "string", "maxLength": 2, - "example": "01" + "example": "01", + "description": "The message category\n" + }, + "acsWindowSize": { + "type": "string", + "maxLength": 2, + "example": "01", + "description": "The acs window size\n" } } }, @@ -152277,9 +156903,51 @@ "properties": { "name": { "type": "string", - "maxLength": 22, + "maxLength": 25, "example": "Euro Electronics", "description": "The name of the merchant" + }, + "alternateName": { + "type": "string", + "maxLength": 25, + "example": "Smyth Holdings PLC", + "description": "The alternate name of the merchant" + }, + "locality": { + "type": "string", + "maxLength": 50, + "example": "New York", + "description": "The locality of the merchant" + }, + "phone": { + "type": "string", + "maxLength": 15, + "example": "555-555-123", + "description": "The phone number of the merchant" + }, + "country": { + "type": "string", + "maxLength": 2, + "example": "US", + "description": "The country code of the merchant" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "example": "170056", + "description": "The postal code of the merchant" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "example": "NY", + "description": "The administrative area of the merchant" + }, + "address1": { + "type": "string", + "maxLength": 60, + "example": "123 47th Street", + "description": "The first line of the merchant's address" } } } @@ -152291,28 +156959,46 @@ "reconciliationId": { "type": "string", "maxLength": 60, - "example": "01234567" + "example": "01234567", + "description": "The reconciliation ID" }, "authorizationOptions": { "type": "object", "properties": { "aftIndicator": { "type": "boolean", - "example": true + "example": true, + "description": "The AFT indicator" + }, + "authIndicator": { + "type": "string", + "example": 1, + "description": "The authorization indicator" + }, + "ignoreCvResult": { + "type": "boolean", + "example": true, + "description": "Ignore the CV result" + }, + "ignoreAvsResult": { + "type": "boolean", + "example": true, + "description": "Ignore the AVS result" }, "initiator": { "type": "object", "properties": { "credentialStoredOnFile": { "type": "boolean", - "example": true + "example": true, + "description": "Store the credential on file" }, "merchantInitiatedTransaction": { "type": "object", "properties": { "reason": { "type": "string", - "maxLength": 1, + "maxLength": 2, "example": 1 } } @@ -152322,7 +157008,20 @@ "businessApplicationId": { "type": "string", "maxLength": 2, - "example": "AA" + "example": "AA", + "description": "The business application Id" + }, + "commerceIndicator": { + "type": "string", + "maxLength": 20, + "example": "INDICATOR", + "description": "The commerce indicator" + }, + "processingInstruction": { + "type": "string", + "maxLength": 50, + "example": "ORDER_SAVED_EXPLICITLY", + "description": "The processing instruction" } } } @@ -152361,14 +157060,26 @@ "administrativeArea": { "type": "string", "maxLength": 2, - "example": "Devon", + "example": "GB", "description": "The administrative area of the recipient" }, "accountType": { "type": "string", "maxLength": 2, - "example": "Checking", + "example": "01", "description": "The account type of the recipient" + }, + "dateOfBirth": { + "type": "string", + "maxLength": 8, + "example": "05111999", + "description": "The date of birth of the recipient" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "example": "170056", + "description": "The postal code of the recipient" } } }, @@ -152377,20 +157088,50 @@ "properties": { "key": { "type": "string", - "maxLength": 50, + "maxLength": 10, + "example": "1", "description": "The key or identifier for the merchant-defined data field" }, "value": { "type": "string", - "maxLength": 255, + "maxLength": 100, + "example": "123456", "description": "The value associated with the merchant-defined data field" } } + }, + "deviceInformation": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "maxLength": 45, + "example": "192.168.1.1", + "description": "The IP Address" + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "typeSelectionIndicator": { + "type": "string", + "maxLength": 1, + "example": "0", + "description": "The card type selection indicator" + } + } + } + } } } }, "orderInformation": { "type": "object", + "description": "If you need to include any fields within the data object, you must use the orderInformation object that is nested inside the data object. This ensures proper structure and compliance with the Unified Checkout schema. This top-level orderInformation field is not intended for use when working with the data object.", "properties": { "amountDetails": { "type": "object", @@ -152674,7 +157415,7 @@ "example0": { "summary": "Generate Unified Checkout Capture Context", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152709,10 +157450,12 @@ "decisionManager": true, "consumerAuthentication": true }, - "orderInformation": { - "amountDetails": { - "totalAmount": "21.00", - "currency": "USD" + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "USD" + } } } } @@ -152720,7 +157463,7 @@ "example1": { "summary": "Generate Unified Checkout Capture Context With Full List of Card Networks", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152784,7 +157527,7 @@ "example2": { "summary": "Generate Unified Checkout Capture Context With Custom Google Payment Options", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152840,7 +157583,7 @@ "example3": { "summary": "Generate Unified Checkout Capture Context With Autocheck Enrollment", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152890,7 +157633,7 @@ "example4": { "summary": "Generate Unified Checkout Capture Context (Opt-out of receiving card number prefix)", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -152941,7 +157684,7 @@ "example5": { "summary": "Generate Unified Checkout Capture Context passing Billing & Shipping", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153036,7 +157779,7 @@ "example6": { "summary": "Generate Unified Checkout Capture Context For Click To Pay Drop-In UI", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153074,7 +157817,7 @@ "example7": { "summary": "Generate Unified Checkout Capture Context ($ Afterpay (US))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153145,7 +157888,7 @@ "example8": { "summary": "Generate Unified Checkout Capture Context (Afterpay (CAN))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153216,7 +157959,7 @@ "example9": { "summary": "Generate Unified Checkout Capture Context (Clearpay (GB))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153289,7 +158032,7 @@ "example10": { "summary": "Generate Unified Checkout Capture Context (Afterpay (AU))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153360,7 +158103,7 @@ "example11": { "summary": "Generate Unified Checkout Capture Context (Afterpay (NZ))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153429,9 +158172,153 @@ "parentTag": "Unified Checkout with Alternate Payments (Buy Now, Pay Later)" }, "example12": { + "summary": "Generate Unified Checkout Capture Context (Bancontact (BE))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "BANCONTACT" + ], + "country": "BE", + "locale": "fr_BE", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "BE", + "NL", + "FR" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "jean.dupont@example.com", + "firstName": "Jean", + "lastName": "Dupont", + "address1": "Avenue Louise 123", + "administrativeArea": "Brussels", + "buildingNumber": 123, + "country": "BE", + "locality": "Brussels", + "postalCode": "1050" + }, + "shipTo": { + "firstName": "Marie", + "lastName": "Dupont", + "address1": "Rue de la Loi 200", + "administrativeArea": "Brussels", + "buildingNumber": 200, + "country": "BE", + "locality": "Brussels", + "postalCode": "1040" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example13": { + "summary": "Generate Unified Checkout Capture Context (DragonPay (PH))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "DRAGONPAY" + ], + "country": "PH", + "locale": "en-PH", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "PH", + "SG", + "MY" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "121.00", + "currency": "PHP" + }, + "billTo": { + "email": "juan.dela.cruz@example.com", + "firstName": "Juan", + "lastName": "Dela Cruz", + "address1": "123 Ayala Avenue", + "administrativeArea": "NCR", + "buildingNumber": 123, + "country": "PH", + "locality": "Makati City", + "postalCode": "1226" + }, + "shipTo": { + "firstName": "Maria", + "lastName": "Dela Cruz", + "address1": "45 Ortigas Center", + "administrativeArea": "NCR", + "buildingNumber": 45, + "country": "PH", + "locality": "Pasig City", + "postalCode": "1605" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example14": { "summary": "Generate Unified Checkout Capture Context (iDEAL (NL))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153499,10 +158386,10 @@ }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" }, - "example13": { + "example15": { "summary": "Generate Unified Checkout Capture Context (Multibanco (PT))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153571,10 +158458,83 @@ }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" }, - "example14": { + "example16": { + "summary": "Generate Unified Checkout Capture Context (MyBank (IT))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "MYBBT" + ], + "country": "IT", + "locale": "it-IT", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "IT", + "ES", + "BE", + "PT" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "EUR" + }, + "billTo": { + "email": "mario.rossi@example.com", + "firstName": "Mario", + "lastName": "Rossi", + "address1": "Via Dante Alighieri 15", + "administrativeArea": "MI", + "buildingNumber": 15, + "country": "IT", + "locality": "Milano", + "postalCode": "20121" + }, + "shipTo": { + "firstName": "Lucia", + "lastName": "Rossi", + "address1": "Corso Vittorio Emanuele II 8", + "administrativeArea": "RM", + "buildingNumber": 8, + "country": "IT", + "locality": "Roma", + "postalCode": "00186" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example17": { "summary": "Generate Unified Checkout Capture Context (Przelewy24|P24 (PL))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153643,10 +158603,10 @@ }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" }, - "example15": { + "example18": { "summary": "Generate Unified Checkout Capture Context (Tink Pay By Bank (GB))", "value": { - "clientVersion": "0.31", + "clientVersion": "0.32", "targetOrigins": [ "https://yourCheckoutPage.com" ], @@ -153712,6 +158672,78 @@ } }, "parentTag": "Unified Checkout with Alternate Payments (Online Bank Transfer)" + }, + "example19": { + "summary": "Generate Unified Checkout Capture Context (Konbini (JP))", + "value": { + "clientVersion": "0.32", + "targetOrigins": [ + "https://yourCheckoutPage.com" + ], + "allowedCardNetworks": [ + "VISA", + "MASTERCARD", + "AMEX" + ], + "allowedPaymentTypes": [ + "APPLEPAY", + "CHECK", + "CLICKTOPAY", + "GOOGLEPAY", + "PANENTRY", + "PAZE", + "KONBINI" + ], + "country": "JP", + "locale": "ja-JP", + "captureMandate": { + "billingType": "FULL", + "requestEmail": true, + "requestPhone": true, + "requestShipping": true, + "shipToCountries": [ + "JP", + "US" + ], + "showAcceptedNetworkIcons": true + }, + "completeMandate": { + "type": "PREFER_AUTH", + "decisionManager": true, + "consumerAuthentication": true + }, + "data": { + "orderInformation": { + "amountDetails": { + "totalAmount": "21.00", + "currency": "JPY" + }, + "billTo": { + "email": "taro.suzuki@example.jp", + "firstName": "Taro", + "lastName": "Suzuki", + "address1": "1-9-1 Marunouchi", + "administrativeArea": "Tokyo", + "buildingNumber": 1, + "country": "JP", + "locality": "Chiyoda-ku", + "postalCode": "100-0005", + "phoneNumber": "0312345678" + }, + "shipTo": { + "firstName": "Hanako", + "lastName": "Suzuki", + "address1": "3-1-1 Umeda", + "administrativeArea": "Osaka", + "buildingNumber": 3, + "country": "JP", + "locality": "Kita-ku", + "postalCode": "530-0001" + } + } + } + }, + "parentTag": "Unified Checkout with Alternate Payments (Post-Pay Reference)" } }, "responses": { @@ -155215,7 +160247,7 @@ "authorizationType": [ "Json Web Token" ], - "overrideMerchantCredential": "echecktestdevcenter001", + "overrideMerchantCredential": "apiref_chase", "SDK_ONLY_AddDisclaimer": true }, "consumes": [ diff --git a/lib/Api/BankAccountValidationApi.php b/lib/Api/BankAccountValidationApi.php index c5ec3fc5e..f1443d781 100644 --- a/lib/Api/BankAccountValidationApi.php +++ b/lib/Api/BankAccountValidationApi.php @@ -105,7 +105,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * * @param \CyberSource\Model\AccountValidationsRequest $accountValidationsRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20013, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20014, HTTP status code, HTTP response headers (array of strings) */ public function bankAccountValidationRequest($accountValidationsRequest) { @@ -123,7 +123,7 @@ public function bankAccountValidationRequest($accountValidationsRequest) * * @param \CyberSource\Model\AccountValidationsRequest $accountValidationsRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20013, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20014, HTTP status code, HTTP response headers (array of strings) */ public function bankAccountValidationRequestWithHttpInfo($accountValidationsRequest) { @@ -188,7 +188,7 @@ public function bankAccountValidationRequestWithHttpInfo($accountValidationsRequ self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20013"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20014"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -197,17 +197,17 @@ public function bankAccountValidationRequestWithHttpInfo($accountValidationsRequ $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse20013', + '\CyberSource\Model\InlineResponse20014', '/bavs/v1/account-validations' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20013', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20014', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20013', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20014', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: diff --git a/lib/Api/BatchesApi.php b/lib/Api/BatchesApi.php index 511d7ba0e..671835d0f 100644 --- a/lib/Api/BatchesApi.php +++ b/lib/Api/BatchesApi.php @@ -103,7 +103,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * * @param string $batchId Unique identification number assigned to the submitted request. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20012, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20013, HTTP status code, HTTP response headers (array of strings) */ public function getBatchReport($batchId) { @@ -121,7 +121,7 @@ public function getBatchReport($batchId) * * @param string $batchId Unique identification number assigned to the submitted request. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20012, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20013, HTTP status code, HTTP response headers (array of strings) */ public function getBatchReportWithHttpInfo($batchId) { @@ -187,7 +187,7 @@ public function getBatchReportWithHttpInfo($batchId) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20012"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20013"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -196,17 +196,17 @@ public function getBatchReportWithHttpInfo($batchId) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse20012', + '\CyberSource\Model\InlineResponse20013', '/accountupdater/v1/batches/{batchId}/report' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20012', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20013', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20012', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20013', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 403: @@ -227,7 +227,7 @@ public function getBatchReportWithHttpInfo($batchId) * * @param string $batchId Unique identification number assigned to the submitted request. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20011, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20012, HTTP status code, HTTP response headers (array of strings) */ public function getBatchStatus($batchId) { @@ -245,7 +245,7 @@ public function getBatchStatus($batchId) * * @param string $batchId Unique identification number assigned to the submitted request. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20011, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20012, HTTP status code, HTTP response headers (array of strings) */ public function getBatchStatusWithHttpInfo($batchId) { @@ -311,7 +311,7 @@ public function getBatchStatusWithHttpInfo($batchId) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20011"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20012"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -320,17 +320,17 @@ public function getBatchStatusWithHttpInfo($batchId) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse20011', + '\CyberSource\Model\InlineResponse20012', '/accountupdater/v1/batches/{batchId}/status' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20011', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20012', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20011', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20012', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 403: @@ -354,7 +354,7 @@ public function getBatchStatusWithHttpInfo($batchId) * @param string $fromDate ISO-8601 format: yyyyMMddTHHmmssZ (optional) * @param string $toDate ISO-8601 format: yyyyMMddTHHmmssZ (optional) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20010, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20011, HTTP status code, HTTP response headers (array of strings) */ public function getBatchesList($offset = '0', $limit = '20', $fromDate = null, $toDate = null) { @@ -375,7 +375,7 @@ public function getBatchesList($offset = '0', $limit = '20', $fromDate = null, $ * @param string $fromDate ISO-8601 format: yyyyMMddTHHmmssZ (optional) * @param string $toDate ISO-8601 format: yyyyMMddTHHmmssZ (optional) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20010, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20011, HTTP status code, HTTP response headers (array of strings) */ public function getBatchesListWithHttpInfo($offset = '0', $limit = '20', $fromDate = null, $toDate = null) { @@ -448,7 +448,7 @@ public function getBatchesListWithHttpInfo($offset = '0', $limit = '20', $fromDa self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20010"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20011"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -457,17 +457,17 @@ public function getBatchesListWithHttpInfo($offset = '0', $limit = '20', $fromDa $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse20010', + '\CyberSource\Model\InlineResponse20011', '/accountupdater/v1/batches' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20010', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20011', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20010', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20011', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 401: diff --git a/lib/Api/CreateNewWebhooksApi.php b/lib/Api/CreateNewWebhooksApi.php index 99e48e8a6..23817cb99 100644 --- a/lib/Api/CreateNewWebhooksApi.php +++ b/lib/Api/CreateNewWebhooksApi.php @@ -103,7 +103,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * * @param string $organizationId The Organization Identifier. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2004[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2005[], HTTP status code, HTTP response headers (array of strings) */ public function findProductsToSubscribe($organizationId) { @@ -121,7 +121,7 @@ public function findProductsToSubscribe($organizationId) * * @param string $organizationId The Organization Identifier. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2004[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2005[], HTTP status code, HTTP response headers (array of strings) */ public function findProductsToSubscribeWithHttpInfo($organizationId) { @@ -187,7 +187,7 @@ public function findProductsToSubscribeWithHttpInfo($organizationId) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2004[]"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2005[]"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -196,17 +196,17 @@ public function findProductsToSubscribeWithHttpInfo($organizationId) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2004[]', + '\CyberSource\Model\InlineResponse2005[]', '/notification-subscriptions/v2/products/{organizationId}' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2004[]', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2005[]', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2004[]', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2005[]', $e->getResponseHeaders()); $e->setResponseObject($data); break; } diff --git a/lib/Api/CustomerApi.php b/lib/Api/CustomerApi.php index 5b0c635e1..6bbed9e96 100644 --- a/lib/Api/CustomerApi.php +++ b/lib/Api/CustomerApi.php @@ -486,7 +486,7 @@ public function patchCustomerWithHttpInfo($customerId, $patchCustomerRequest, $p } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "patchCustomer,patchCustomerWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); @@ -639,7 +639,7 @@ public function postCustomerWithHttpInfo($postCustomerRequest, $profileId = null } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postCustomer,postCustomerWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Api/CustomerPaymentInstrumentApi.php b/lib/Api/CustomerPaymentInstrumentApi.php index a53c2544f..df5c889fb 100644 --- a/lib/Api/CustomerPaymentInstrumentApi.php +++ b/lib/Api/CustomerPaymentInstrumentApi.php @@ -699,7 +699,7 @@ public function patchCustomersPaymentInstrumentWithHttpInfo($customerId, $paymen } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "patchCustomersPaymentInstrument,patchCustomersPaymentInstrumentWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); @@ -867,7 +867,7 @@ public function postCustomerPaymentInstrumentWithHttpInfo($customerId, $postCust } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postCustomerPaymentInstrument,postCustomerPaymentInstrumentWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Api/CustomerShippingAddressApi.php b/lib/Api/CustomerShippingAddressApi.php index c9ffd4658..e18d23994 100644 --- a/lib/Api/CustomerShippingAddressApi.php +++ b/lib/Api/CustomerShippingAddressApi.php @@ -699,7 +699,7 @@ public function patchCustomersShippingAddressWithHttpInfo($customerId, $shipping } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "patchCustomersShippingAddress,patchCustomersShippingAddressWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); @@ -867,7 +867,7 @@ public function postCustomerShippingAddressWithHttpInfo($customerId, $postCustom } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postCustomerShippingAddress,postCustomerShippingAddressWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Api/DecisionManagerApi.php b/lib/Api/DecisionManagerApi.php index 4731489ae..96f332019 100644 --- a/lib/Api/DecisionManagerApi.php +++ b/lib/Api/DecisionManagerApi.php @@ -104,7 +104,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * @param string $id An unique identification number generated by Cybersource to identify the submitted request. (required) * @param \CyberSource\Model\CaseManagementActionsRequest $caseManagementActionsRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2001, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2002, HTTP status code, HTTP response headers (array of strings) */ public function actionDecisionManagerCase($id, $caseManagementActionsRequest) { @@ -123,7 +123,7 @@ public function actionDecisionManagerCase($id, $caseManagementActionsRequest) * @param string $id An unique identification number generated by Cybersource to identify the submitted request. (required) * @param \CyberSource\Model\CaseManagementActionsRequest $caseManagementActionsRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2001, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2002, HTTP status code, HTTP response headers (array of strings) */ public function actionDecisionManagerCaseWithHttpInfo($id, $caseManagementActionsRequest) { @@ -201,7 +201,7 @@ public function actionDecisionManagerCaseWithHttpInfo($id, $caseManagementAction self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2001"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2002"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -210,17 +210,17 @@ public function actionDecisionManagerCaseWithHttpInfo($id, $caseManagementAction $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2001', + '\CyberSource\Model\InlineResponse2002', '/risk/v1/decisions/{id}/actions' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2001', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2002', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2001', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2002', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: diff --git a/lib/Api/DeviceDeAssociationApi.php b/lib/Api/DeviceDeAssociationApi.php index 255d7151b..60e87b6c7 100644 --- a/lib/Api/DeviceDeAssociationApi.php +++ b/lib/Api/DeviceDeAssociationApi.php @@ -238,7 +238,7 @@ public function deleteTerminalAssociationWithHttpInfo($deAssociationRequestBody) * * @param \CyberSource\Model\DeviceDeAssociateV3Request[] $deviceDeAssociateV3Request deviceId that has to be de-associated to the destination organizationId. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2008[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2009[], HTTP status code, HTTP response headers (array of strings) */ public function postDeAssociateV3Terminal($deviceDeAssociateV3Request) { @@ -256,7 +256,7 @@ public function postDeAssociateV3Terminal($deviceDeAssociateV3Request) * * @param \CyberSource\Model\DeviceDeAssociateV3Request[] $deviceDeAssociateV3Request deviceId that has to be de-associated to the destination organizationId. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2008[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2009[], HTTP status code, HTTP response headers (array of strings) */ public function postDeAssociateV3TerminalWithHttpInfo($deviceDeAssociateV3Request) { @@ -321,7 +321,7 @@ public function postDeAssociateV3TerminalWithHttpInfo($deviceDeAssociateV3Reques self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2008[]"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2009[]"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -330,17 +330,17 @@ public function postDeAssociateV3TerminalWithHttpInfo($deviceDeAssociateV3Reques $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2008[]', + '\CyberSource\Model\InlineResponse2009[]', '/dms/v3/devices/deassociate' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2008[]', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2009[]', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2008[]', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2009[]', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 206: diff --git a/lib/Api/DeviceSearchApi.php b/lib/Api/DeviceSearchApi.php index 75ba3bb92..257ca75fe 100644 --- a/lib/Api/DeviceSearchApi.php +++ b/lib/Api/DeviceSearchApi.php @@ -103,7 +103,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * * @param \CyberSource\Model\PostDeviceSearchRequest $postDeviceSearchRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2007, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2008, HTTP status code, HTTP response headers (array of strings) */ public function postSearchQuery($postDeviceSearchRequest) { @@ -121,7 +121,7 @@ public function postSearchQuery($postDeviceSearchRequest) * * @param \CyberSource\Model\PostDeviceSearchRequest $postDeviceSearchRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2007, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2008, HTTP status code, HTTP response headers (array of strings) */ public function postSearchQueryWithHttpInfo($postDeviceSearchRequest) { @@ -186,7 +186,7 @@ public function postSearchQueryWithHttpInfo($postDeviceSearchRequest) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2007"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2008"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -195,17 +195,17 @@ public function postSearchQueryWithHttpInfo($postDeviceSearchRequest) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2007', + '\CyberSource\Model\InlineResponse2008', '/dms/v2/devices/search' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2007', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2008', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2007', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2008', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -242,7 +242,7 @@ public function postSearchQueryWithHttpInfo($postDeviceSearchRequest) * * @param \CyberSource\Model\PostDeviceSearchRequestV3 $postDeviceSearchRequestV3 (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2009, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20010, HTTP status code, HTTP response headers (array of strings) */ public function postSearchQueryV3($postDeviceSearchRequestV3) { @@ -260,7 +260,7 @@ public function postSearchQueryV3($postDeviceSearchRequestV3) * * @param \CyberSource\Model\PostDeviceSearchRequestV3 $postDeviceSearchRequestV3 (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2009, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20010, HTTP status code, HTTP response headers (array of strings) */ public function postSearchQueryV3WithHttpInfo($postDeviceSearchRequestV3) { @@ -325,7 +325,7 @@ public function postSearchQueryV3WithHttpInfo($postDeviceSearchRequestV3) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2009"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20010"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -334,17 +334,17 @@ public function postSearchQueryV3WithHttpInfo($postDeviceSearchRequestV3) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2009', + '\CyberSource\Model\InlineResponse20010', '/dms/v3/devices/search' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2009', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20010', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2009', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20010', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: diff --git a/lib/Api/InstrumentIdentifierApi.php b/lib/Api/InstrumentIdentifierApi.php index d39ca3e6c..fe5dc4ef6 100644 --- a/lib/Api/InstrumentIdentifierApi.php +++ b/lib/Api/InstrumentIdentifierApi.php @@ -670,7 +670,7 @@ public function patchInstrumentIdentifierWithHttpInfo($instrumentIdentifierId, $ } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "patchInstrumentIdentifier,patchInstrumentIdentifierWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); @@ -830,7 +830,7 @@ public function postInstrumentIdentifierWithHttpInfo($postInstrumentIdentifierRe } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postInstrumentIdentifier,postInstrumentIdentifierWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); @@ -995,7 +995,7 @@ public function postInstrumentIdentifierEnrollmentWithHttpInfo($instrumentIdenti } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postInstrumentIdentifierEnrollment,postInstrumentIdentifierEnrollmentWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Api/ManageWebhooksApi.php b/lib/Api/ManageWebhooksApi.php index b8f198d10..f30244c69 100644 --- a/lib/Api/ManageWebhooksApi.php +++ b/lib/Api/ManageWebhooksApi.php @@ -341,7 +341,7 @@ public function getWebhookSubscriptionByIdWithHttpInfo($webhookId) * @param string $productId The Product Identifier. (optional) * @param string $eventType The Event Type. (optional) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2005[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2006[], HTTP status code, HTTP response headers (array of strings) */ public function getWebhookSubscriptionsByOrg($organizationId, $productId = null, $eventType = null) { @@ -361,7 +361,7 @@ public function getWebhookSubscriptionsByOrg($organizationId, $productId = null, * @param string $productId The Product Identifier. (optional) * @param string $eventType The Event Type. (optional) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2005[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2006[], HTTP status code, HTTP response headers (array of strings) */ public function getWebhookSubscriptionsByOrgWithHttpInfo($organizationId, $productId = null, $eventType = null) { @@ -434,7 +434,7 @@ public function getWebhookSubscriptionsByOrgWithHttpInfo($organizationId, $produ self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2005[]"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2006[]"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -443,17 +443,17 @@ public function getWebhookSubscriptionsByOrgWithHttpInfo($organizationId, $produ $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2005[]', + '\CyberSource\Model\InlineResponse2006[]', '/notification-subscriptions/v2/webhooks' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2005[]', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2006[]', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2005[]', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2006[]', $e->getResponseHeaders()); $e->setResponseObject($data); break; } @@ -591,7 +591,7 @@ public function notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo($we * @param string $webhookId The Webhook Identifier. (required) * @param \CyberSource\Model\UpdateWebhook $updateWebhook The webhook payload or changes to apply. (optional) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2006, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2007, HTTP status code, HTTP response headers (array of strings) */ public function notificationSubscriptionsV2WebhooksWebhookIdPatch($webhookId, $updateWebhook = null) { @@ -610,7 +610,7 @@ public function notificationSubscriptionsV2WebhooksWebhookIdPatch($webhookId, $u * @param string $webhookId The Webhook Identifier. (required) * @param \CyberSource\Model\UpdateWebhook $updateWebhook The webhook payload or changes to apply. (optional) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2006, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2007, HTTP status code, HTTP response headers (array of strings) */ public function notificationSubscriptionsV2WebhooksWebhookIdPatchWithHttpInfo($webhookId, $updateWebhook = null) { @@ -683,7 +683,7 @@ public function notificationSubscriptionsV2WebhooksWebhookIdPatchWithHttpInfo($w self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2006"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2007"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -692,17 +692,17 @@ public function notificationSubscriptionsV2WebhooksWebhookIdPatchWithHttpInfo($w $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2006', + '\CyberSource\Model\InlineResponse2007', '/notification-subscriptions/v2/webhooks/{webhookId}' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2006', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2007', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2006', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2007', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 404: diff --git a/lib/Api/MerchantBoardingApi.php b/lib/Api/MerchantBoardingApi.php index 4bf939b96..6775dfc4d 100644 --- a/lib/Api/MerchantBoardingApi.php +++ b/lib/Api/MerchantBoardingApi.php @@ -103,7 +103,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * * @param string $registrationId Identifies the boarding registration to be updated (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2003, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2004, HTTP status code, HTTP response headers (array of strings) */ public function getRegistration($registrationId) { @@ -121,7 +121,7 @@ public function getRegistration($registrationId) * * @param string $registrationId Identifies the boarding registration to be updated (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2003, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2004, HTTP status code, HTTP response headers (array of strings) */ public function getRegistrationWithHttpInfo($registrationId) { @@ -187,7 +187,7 @@ public function getRegistrationWithHttpInfo($registrationId) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2003"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2004"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -196,17 +196,17 @@ public function getRegistrationWithHttpInfo($registrationId) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2003', + '\CyberSource\Model\InlineResponse2004', '/boarding/v1/registrations/{registrationId}' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2003', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2004', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2003', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2004', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: diff --git a/lib/Api/MerchantDefinedFieldsApi.php b/lib/Api/MerchantDefinedFieldsApi.php index f4d0745a9..e8ccb96ad 100644 --- a/lib/Api/MerchantDefinedFieldsApi.php +++ b/lib/Api/MerchantDefinedFieldsApi.php @@ -104,7 +104,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * @param string $referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) * @param \CyberSource\Model\MerchantDefinedFieldDefinitionRequest $merchantDefinedFieldDefinitionRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2002[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2003[], HTTP status code, HTTP response headers (array of strings) */ public function createMerchantDefinedFieldDefinition($referenceType, $merchantDefinedFieldDefinitionRequest) { @@ -123,7 +123,7 @@ public function createMerchantDefinedFieldDefinition($referenceType, $merchantDe * @param string $referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) * @param \CyberSource\Model\MerchantDefinedFieldDefinitionRequest $merchantDefinedFieldDefinitionRequest (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2002[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2003[], HTTP status code, HTTP response headers (array of strings) */ public function createMerchantDefinedFieldDefinitionWithHttpInfo($referenceType, $merchantDefinedFieldDefinitionRequest) { @@ -201,7 +201,7 @@ public function createMerchantDefinedFieldDefinitionWithHttpInfo($referenceType, self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2002[]"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2003[]"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -210,17 +210,17 @@ public function createMerchantDefinedFieldDefinitionWithHttpInfo($referenceType, $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2002[]', + '\CyberSource\Model\InlineResponse2003[]', '/invoicing/v2/{referenceType}/merchantDefinedFields' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2002[]', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2003[]', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2002[]', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2003[]', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -380,7 +380,7 @@ public function deleteMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceTyp * * @param string $referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2002[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2003[], HTTP status code, HTTP response headers (array of strings) */ public function getMerchantDefinedFieldsDefinitions($referenceType) { @@ -398,7 +398,7 @@ public function getMerchantDefinedFieldsDefinitions($referenceType) * * @param string $referenceType The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2002[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2003[], HTTP status code, HTTP response headers (array of strings) */ public function getMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType) { @@ -464,7 +464,7 @@ public function getMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType) self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2002[]"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2003[]"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -473,17 +473,17 @@ public function getMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType) $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2002[]', + '\CyberSource\Model\InlineResponse2003[]', '/invoicing/v2/{referenceType}/merchantDefinedFields' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2002[]', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2003[]', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2002[]', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2003[]', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 404: @@ -506,7 +506,7 @@ public function getMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType) * @param int $id (required) * @param \CyberSource\Model\MerchantDefinedFieldCore $merchantDefinedFieldCore (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2002[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2003[], HTTP status code, HTTP response headers (array of strings) */ public function putMerchantDefinedFieldsDefinitions($referenceType, $id, $merchantDefinedFieldCore) { @@ -526,7 +526,7 @@ public function putMerchantDefinedFieldsDefinitions($referenceType, $id, $mercha * @param int $id (required) * @param \CyberSource\Model\MerchantDefinedFieldCore $merchantDefinedFieldCore (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse2002[], HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2003[], HTTP status code, HTTP response headers (array of strings) */ public function putMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType, $id, $merchantDefinedFieldCore) { @@ -617,7 +617,7 @@ public function putMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType, self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2002[]"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2003[]"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -626,17 +626,17 @@ public function putMerchantDefinedFieldsDefinitionsWithHttpInfo($referenceType, $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse2002[]', + '\CyberSource\Model\InlineResponse2003[]', '/invoicing/v2/{referenceType}/merchantDefinedFields/{id}' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2002[]', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2003[]', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2002[]', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2003[]', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: diff --git a/lib/Api/OffersApi.php b/lib/Api/OffersApi.php index abb8fc5ec..82f264160 100644 --- a/lib/Api/OffersApi.php +++ b/lib/Api/OffersApi.php @@ -290,7 +290,7 @@ public function createOfferWithHttpInfo($contentType, $xRequestid, $vCMerchantId * @param string $vCOrganizationId (required) * @param string $id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20014, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20015, HTTP status code, HTTP response headers (array of strings) */ public function getOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $id) { @@ -313,7 +313,7 @@ public function getOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelatio * @param string $vCOrganizationId (required) * @param string $id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse20014, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse20015, HTTP status code, HTTP response headers (array of strings) */ public function getOfferWithHttpInfo($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $id) { @@ -424,7 +424,7 @@ public function getOfferWithHttpInfo($contentType, $xRequestid, $vCMerchantId, $ self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20014"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse20015"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -433,17 +433,17 @@ public function getOfferWithHttpInfo($contentType, $xRequestid, $vCMerchantId, $ $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse20014', + '\CyberSource\Model\InlineResponse20015', '/vas/v1/currencyconversion/{id}' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20014', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse20015', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20014', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse20015', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 404: diff --git a/lib/Api/PaymentInstrumentApi.php b/lib/Api/PaymentInstrumentApi.php index faf67917f..8921480ff 100644 --- a/lib/Api/PaymentInstrumentApi.php +++ b/lib/Api/PaymentInstrumentApi.php @@ -495,7 +495,7 @@ public function patchPaymentInstrumentWithHttpInfo($paymentInstrumentId, $patchP } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "patchPaymentInstrument,patchPaymentInstrumentWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); @@ -655,7 +655,7 @@ public function postPaymentInstrumentWithHttpInfo($postPaymentInstrumentRequest, } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postPaymentInstrument,postPaymentInstrumentWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Api/SubscriptionsApi.php b/lib/Api/SubscriptionsApi.php index 633d7fa7d..c2f771a30 100644 --- a/lib/Api/SubscriptionsApi.php +++ b/lib/Api/SubscriptionsApi.php @@ -99,17 +99,17 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) /** * Operation activateSubscription * - * Activate a Subscription + * Reactivating a Suspended Subscription * * @param string $id Subscription Id (required) - * @param bool $processSkippedPayments Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. (optional, default to true) + * @param bool $processMissedPayments Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true. When any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored. (optional, default to true) * @throws \CyberSource\ApiException on non-2xx response * @return array of \CyberSource\Model\ActivateSubscriptionResponse, HTTP status code, HTTP response headers (array of strings) */ - public function activateSubscription($id, $processSkippedPayments = 'true') + public function activateSubscription($id, $processMissedPayments = 'true') { self::$logger->info('CALL TO METHOD activateSubscription STARTED'); - list($response, $statusCode, $httpHeader) = $this->activateSubscriptionWithHttpInfo($id, $processSkippedPayments); + list($response, $statusCode, $httpHeader) = $this->activateSubscriptionWithHttpInfo($id, $processMissedPayments); self::$logger->info('CALL TO METHOD activateSubscription ENDED'); self::$logger->close(); return [$response, $statusCode, $httpHeader]; @@ -118,14 +118,14 @@ public function activateSubscription($id, $processSkippedPayments = 'true') /** * Operation activateSubscriptionWithHttpInfo * - * Activate a Subscription + * Reactivating a Suspended Subscription * * @param string $id Subscription Id (required) - * @param bool $processSkippedPayments Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. (optional, default to true) + * @param bool $processMissedPayments Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true. When any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored. (optional, default to true) * @throws \CyberSource\ApiException on non-2xx response * @return array of \CyberSource\Model\ActivateSubscriptionResponse, HTTP status code, HTTP response headers (array of strings) */ - public function activateSubscriptionWithHttpInfo($id, $processSkippedPayments = 'true') + public function activateSubscriptionWithHttpInfo($id, $processMissedPayments = 'true') { // verify the required parameter 'id' is set if ($id === null) { @@ -147,8 +147,8 @@ public function activateSubscriptionWithHttpInfo($id, $processSkippedPayments = $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']); // query params - if ($processSkippedPayments !== null) { - $queryParams['processSkippedPayments'] = $this->apiClient->getSerializer()->toQueryValue($processSkippedPayments); + if ($processMissedPayments !== null) { + $queryParams['processMissedPayments'] = $this->apiClient->getSerializer()->toQueryValue($processMissedPayments); } // path params if ($id !== null) { diff --git a/lib/Api/TokenApi.php b/lib/Api/TokenApi.php index 83852ce4c..d8550c209 100644 --- a/lib/Api/TokenApi.php +++ b/lib/Api/TokenApi.php @@ -105,7 +105,7 @@ public function setApiClient(\CyberSource\ApiClient $apiClient) * @param string $tokenProvider The token provider. (required) * @param string $assetType The type of asset. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse200, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2001, HTTP status code, HTTP response headers (array of strings) */ public function getCardArtAsset($instrumentIdentifierId, $tokenProvider, $assetType) { @@ -125,7 +125,7 @@ public function getCardArtAsset($instrumentIdentifierId, $tokenProvider, $assetT * @param string $tokenProvider The token provider. (required) * @param string $assetType The type of asset. (required) * @throws \CyberSource\ApiException on non-2xx response - * @return array of \CyberSource\Model\InlineResponse200, HTTP status code, HTTP response headers (array of strings) + * @return array of \CyberSource\Model\InlineResponse2001, HTTP status code, HTTP response headers (array of strings) */ public function getCardArtAssetWithHttpInfo($instrumentIdentifierId, $tokenProvider, $assetType) { @@ -217,7 +217,7 @@ public function getCardArtAssetWithHttpInfo($instrumentIdentifierId, $tokenProvi self::$logger->debug("Body Parameter :\n" . $printHttpBody); } - self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse200"); + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse2001"); // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -226,17 +226,17 @@ public function getCardArtAssetWithHttpInfo($instrumentIdentifierId, $tokenProvi $queryParams, $httpBody, $headerParams, - '\CyberSource\Model\InlineResponse200', + '\CyberSource\Model\InlineResponse2001', '/tms/v2/tokens/{instrumentIdentifierId}/{tokenProvider}/assets/{assetType}' ); self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); - return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse200', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse2001', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse200', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse2001', $e->getResponseHeaders()); $e->setResponseObject($data); break; } @@ -334,7 +334,7 @@ public function postTokenPaymentCredentialsWithHttpInfo($tokenId, $postPaymentCr } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postTokenPaymentCredentials,postTokenPaymentCredentialsWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Api/TokenizeApi.php b/lib/Api/TokenizeApi.php new file mode 100644 index 000000000..5e4936627 --- /dev/null +++ b/lib/Api/TokenizeApi.php @@ -0,0 +1,239 @@ +apiClient = $apiClient; + + if (self::$logger === null) { + self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(get_class($this)), $apiClient->merchantConfig->getLogConfiguration()); + } + } + + /** + * Get API client + * + * @return \CyberSource\ApiClient get the API client + */ + public function getApiClient() + { + return $this->apiClient; + } + + /** + * Set the API client + * + * @param \CyberSource\ApiClient $apiClient set the API client + * + * @return TokenizeApi + */ + public function setApiClient(\CyberSource\ApiClient $apiClient) + { + $this->apiClient = $apiClient; + return $this; + } + + /** + * Operation tokenize + * + * Tokenize + * + * @param \CyberSource\Model\PostTokenizeRequest $postTokenizeRequest (required) + * @param string $profileId The Id of a profile containing user specific TMS configuration. (optional) + * @throws \CyberSource\ApiException on non-2xx response + * @return array of \CyberSource\Model\InlineResponse200, HTTP status code, HTTP response headers (array of strings) + */ + public function tokenize($postTokenizeRequest, $profileId = null) + { + self::$logger->info('CALL TO METHOD tokenize STARTED'); + list($response, $statusCode, $httpHeader) = $this->tokenizeWithHttpInfo($postTokenizeRequest, $profileId); + self::$logger->info('CALL TO METHOD tokenize ENDED'); + self::$logger->close(); + return [$response, $statusCode, $httpHeader]; + } + + /** + * Operation tokenizeWithHttpInfo + * + * Tokenize + * + * @param \CyberSource\Model\PostTokenizeRequest $postTokenizeRequest (required) + * @param string $profileId The Id of a profile containing user specific TMS configuration. (optional) + * @throws \CyberSource\ApiException on non-2xx response + * @return array of \CyberSource\Model\InlineResponse200, HTTP status code, HTTP response headers (array of strings) + */ + public function tokenizeWithHttpInfo($postTokenizeRequest, $profileId = null) + { + // verify the required parameter 'postTokenizeRequest' is set + if ($postTokenizeRequest === null) { + self::$logger->error("InvalidArgumentException : Missing the required parameter $postTokenizeRequest when calling tokenize"); + throw new \InvalidArgumentException('Missing the required parameter $postTokenizeRequest when calling tokenize'); + } + // parse inputs + $resourcePath = "/tms/v2/tokenize"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json;charset=utf-8']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']); + + // header params + if ($profileId !== null) { + $headerParams['profile-id'] = $this->apiClient->getSerializer()->toHeaderValue($profileId); + } + // body params + $_tempBody = null; + if (isset($postTokenizeRequest)) { + $_tempBody = $postTokenizeRequest; + } + + $sdkTracker = new \CyberSource\Utilities\Tracking\SdkTracker(); + $modelClassLocation = explode('\\', '\CyberSource\Model\PostTokenizeRequest'); + + $_tempBody = $sdkTracker->insertDeveloperIdTracker($_tempBody, end($modelClassLocation), $this->apiClient->merchantConfig->getRunEnvironment(), $this->apiClient->merchantConfig->getDefaultDeveloperId()); + + // for model (json/xml) + if (isset($_tempBody) and count($formParams) <= 0) { + $httpBody = $_tempBody; // $_tempBody is the method argument, if present + } elseif (count($formParams) > 0) { + $httpBody = MultipartHelper::build_data_files($boundary, $formParams); // for HTTP post (form) + } + + //MLE check and mle encryption for req body + $inboundMLEStatus = 'mandatory'; + if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "tokenize,tokenizeWithHttpInfo")) { + try { + $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); + } catch (Exception $e) { + self::$logger->error("Failed to encrypt request body: $e"); + throw new ApiException("Failed to encrypt request body : " . $e->getMessage()); + } + } + + + // Logging + self::$logger->debug("Resource : POST $resourcePath"); + if (isset($httpBody) and count($formParams) <= 0) { + if ($this->apiClient->merchantConfig->getLogConfiguration()->isMaskingEnabled()) { + $printHttpBody = \CyberSource\Utilities\Helpers\DataMasker::maskData($httpBody); + } else { + $printHttpBody = $httpBody; + } + + self::$logger->debug("Body Parameter :\n" . $printHttpBody); + } + + self::$logger->debug("Return Type : \CyberSource\Model\InlineResponse200"); + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + '\CyberSource\Model\InlineResponse200', + '/tms/v2/tokenize' + ); + + self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); + + return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\InlineResponse200', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse200', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse400', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 403: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse403', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 424: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse424', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 500: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse500', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + self::$logger->error("ApiException : $e"); + throw $e; + } + } +} diff --git a/lib/Api/TokenizedCardApi.php b/lib/Api/TokenizedCardApi.php index 367a5af98..2cebe860c 100644 --- a/lib/Api/TokenizedCardApi.php +++ b/lib/Api/TokenizedCardApi.php @@ -388,6 +388,163 @@ public function getTokenizedCardWithHttpInfo($tokenizedCardId, $profileId = null } } + /** + * Operation postIssuerLifeCycleSimulation + * + * Simulate Issuer Life Cycle Management Events + * + * @param string $profileId The Id of a profile containing user specific TMS configuration. (required) + * @param string $tokenizedCardId The Id of a tokenized card. (required) + * @param \CyberSource\Model\PostIssuerLifeCycleSimulationRequest $postIssuerLifeCycleSimulationRequest (required) + * @throws \CyberSource\ApiException on non-2xx response + * @return array of void, HTTP status code, HTTP response headers (array of strings) + */ + public function postIssuerLifeCycleSimulation($profileId, $tokenizedCardId, $postIssuerLifeCycleSimulationRequest) + { + self::$logger->info('CALL TO METHOD postIssuerLifeCycleSimulation STARTED'); + list($response, $statusCode, $httpHeader) = $this->postIssuerLifeCycleSimulationWithHttpInfo($profileId, $tokenizedCardId, $postIssuerLifeCycleSimulationRequest); + self::$logger->info('CALL TO METHOD postIssuerLifeCycleSimulation ENDED'); + self::$logger->close(); + return [$response, $statusCode, $httpHeader]; + } + + /** + * Operation postIssuerLifeCycleSimulationWithHttpInfo + * + * Simulate Issuer Life Cycle Management Events + * + * @param string $profileId The Id of a profile containing user specific TMS configuration. (required) + * @param string $tokenizedCardId The Id of a tokenized card. (required) + * @param \CyberSource\Model\PostIssuerLifeCycleSimulationRequest $postIssuerLifeCycleSimulationRequest (required) + * @throws \CyberSource\ApiException on non-2xx response + * @return array of null, HTTP status code, HTTP response headers (array of strings) + */ + public function postIssuerLifeCycleSimulationWithHttpInfo($profileId, $tokenizedCardId, $postIssuerLifeCycleSimulationRequest) + { + // verify the required parameter 'profileId' is set + if ($profileId === null) { + self::$logger->error("InvalidArgumentException : Missing the required parameter $profileId when calling postIssuerLifeCycleSimulation"); + throw new \InvalidArgumentException('Missing the required parameter $profileId when calling postIssuerLifeCycleSimulation'); + } + // verify the required parameter 'tokenizedCardId' is set + if ($tokenizedCardId === null) { + self::$logger->error("InvalidArgumentException : Missing the required parameter $tokenizedCardId when calling postIssuerLifeCycleSimulation"); + throw new \InvalidArgumentException('Missing the required parameter $tokenizedCardId when calling postIssuerLifeCycleSimulation'); + } + // verify the required parameter 'postIssuerLifeCycleSimulationRequest' is set + if ($postIssuerLifeCycleSimulationRequest === null) { + self::$logger->error("InvalidArgumentException : Missing the required parameter $postIssuerLifeCycleSimulationRequest when calling postIssuerLifeCycleSimulation"); + throw new \InvalidArgumentException('Missing the required parameter $postIssuerLifeCycleSimulationRequest when calling postIssuerLifeCycleSimulation'); + } + // parse inputs + $resourcePath = "/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json;charset=utf-8']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']); + + // header params + if ($profileId !== null) { + $headerParams['profile-id'] = $this->apiClient->getSerializer()->toHeaderValue($profileId); + } + // path params + if ($tokenizedCardId !== null) { + $resourcePath = str_replace( + "{" . "tokenizedCardId" . "}", + $this->apiClient->getSerializer()->toPathValue($tokenizedCardId), + $resourcePath + ); + } + // body params + $_tempBody = null; + if (isset($postIssuerLifeCycleSimulationRequest)) { + $_tempBody = $postIssuerLifeCycleSimulationRequest; + } + + $sdkTracker = new \CyberSource\Utilities\Tracking\SdkTracker(); + $modelClassLocation = explode('\\', '\CyberSource\Model\PostIssuerLifeCycleSimulationRequest'); + + $_tempBody = $sdkTracker->insertDeveloperIdTracker($_tempBody, end($modelClassLocation), $this->apiClient->merchantConfig->getRunEnvironment(), $this->apiClient->merchantConfig->getDefaultDeveloperId()); + + // for model (json/xml) + if (isset($_tempBody) and count($formParams) <= 0) { + $httpBody = $_tempBody; // $_tempBody is the method argument, if present + } elseif (count($formParams) > 0) { + $httpBody = MultipartHelper::build_data_files($boundary, $formParams); // for HTTP post (form) + } + + //MLE check and mle encryption for req body + $inboundMLEStatus = 'false'; + if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postIssuerLifeCycleSimulation,postIssuerLifeCycleSimulationWithHttpInfo")) { + try { + $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); + } catch (Exception $e) { + self::$logger->error("Failed to encrypt request body: $e"); + throw new ApiException("Failed to encrypt request body : " . $e->getMessage()); + } + } + + + // Logging + self::$logger->debug("Resource : POST $resourcePath"); + if (isset($httpBody) and count($formParams) <= 0) { + if ($this->apiClient->merchantConfig->getLogConfiguration()->isMaskingEnabled()) { + $printHttpBody = \CyberSource\Utilities\Helpers\DataMasker::maskData($httpBody); + } else { + $printHttpBody = $httpBody; + } + + self::$logger->debug("Body Parameter :\n" . $printHttpBody); + } + + self::$logger->debug("Return Type : null"); + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + null, + '/tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations' + ); + + self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader)); + + return [$response, $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse400', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 403: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse403', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 404: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse424', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 500: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\InlineResponse500', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + self::$logger->error("ApiException : $e"); + throw $e; + } + } + /** * Operation postTokenizedCard * @@ -461,7 +618,7 @@ public function postTokenizedCardWithHttpInfo($tokenizedcardRequest, $profileId } //MLE check and mle encryption for req body - $inboundMLEStatus = 'false'; + $inboundMLEStatus = 'optional'; if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $inboundMLEStatus, "postTokenizedCard,postTokenizedCardWithHttpInfo")) { try { $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody); diff --git a/lib/Authentication/Util/Cache.php b/lib/Authentication/Util/Cache.php index e47b4d286..0112df20c 100644 --- a/lib/Authentication/Util/Cache.php +++ b/lib/Authentication/Util/Cache.php @@ -299,4 +299,17 @@ public static function validateCertificateExpiry($certificate, $keyAlias, $cache // throw new MLEException("Error validating certificate expiry: " . $e->getMessage()); } } + + public static function addPublicKeyToCache($runEnvironment, $keyId, $publicKey) { + $cacheKey = GlobalParameter::PUBLIC_KEY_CACHE_IDENTIFIER . "_" . $runEnvironment . "_" . $keyId; + self::$file_cache[$cacheKey] = $publicKey; + } + + public static function getPublicKeyFromCache($runEnvironment, $keyId) { + $cacheKey = GlobalParameter::PUBLIC_KEY_CACHE_IDENTIFIER . "_" . $runEnvironment . "_" . $keyId; + if (isset(self::$file_cache[$cacheKey])) { + return self::$file_cache[$cacheKey]; + } + throw new \Exception("Public key not found in cache for [RunEnvironment: $runEnvironment, KeyId: $keyId]"); + } } diff --git a/lib/Authentication/Util/GlobalParameter.php b/lib/Authentication/Util/GlobalParameter.php index f6e61914f..aec4ad339 100644 --- a/lib/Authentication/Util/GlobalParameter.php +++ b/lib/Authentication/Util/GlobalParameter.php @@ -109,5 +109,6 @@ class GlobalParameter const CERTIFICATE_EXPIRY_DATE_WARNING_DAYS = 90; const REQUEST_MLE_AUTH_ERROR = "Request MLE is only supported in JWT auth type"; const EMPTY_PRIVATE_OR_PUBLIC_KEY_ERROR = "Private key or public key is empty"; + const PUBLIC_KEY_CACHE_IDENTIFIER = "FlexV2PublicKeys"; } ?> diff --git a/lib/Authentication/Util/JWT/JWTExceptions.php b/lib/Authentication/Util/JWT/JWTExceptions.php new file mode 100644 index 000000000..2904e911a --- /dev/null +++ b/lib/Authentication/Util/JWT/JWTExceptions.php @@ -0,0 +1,197 @@ +cause = $cause; + } + + /** + * Get the underlying cause of this exception + * + * @return Exception|null The cause exception, or null if no cause was set + */ + public function getCause() + { + return $this->cause; + } + + /** + * Check if this exception has an underlying cause + * + * @return bool True if a cause exception exists, false otherwise + */ + public function hasCause() + { + return $this->cause !== null; + } + + /** + * Get enhanced string representation of the exception with cause chain + * + * @return string Formatted exception string with cause information + */ + public function __toString() + { + $result = parent::__toString(); + + if ($this->hasCause()) { + $result .= "\nCaused by: " . $this->cause->__toString(); + } + + return $result; + } + + /** + * Get the full exception chain as an array + * + * @return Exception[] Array of exceptions in the chain, starting with this exception + */ + public function getExceptionChain() + { + $chain = [$this]; + $current = $this->getPrevious(); + + while ($current !== null) { + $chain[] = $current; + $current = $current->getPrevious(); + } + + return $chain; + } + + /** + * Get a detailed error message including the full exception chain + * + * @return string Detailed error message with all causes + */ + public function getDetailedMessage() + { + $messages = []; + $chain = $this->getExceptionChain(); + + foreach ($chain as $index => $exception) { + $prefix = $index === 0 ? '' : 'Caused by: '; + $messages[] = $prefix . get_class($exception) . ': ' . $exception->getMessage(); + } + + return implode("\n", $messages); + } +} + +/** + * Invalid JWK Exception + * + * Thrown when a JSON Web Key (JWK) is invalid or malformed. + * This can occur during key parsing, validation, or when required + * JWK parameters are missing or incorrect. + * + * @category Class + * @package CyberSource\Authentication\Util\JWT + * @author CyberSource + */ +class InvalidJwkException extends JWTException +{ + /** + * Constructor + * + * @param string $message Error message describing the invalid JWK + * @param Exception|null $cause Optional underlying cause of the error + * @param int $code Optional error code (default: 0) + */ + public function __construct($message = "Invalid JSON Web Key (JWK)", ?Exception $cause = null, $code = 0) + { + parent::__construct($message, $cause, $code); + } +} + +/** + * Invalid JWT Exception + * + * Thrown when a JWT token is invalid, malformed, or cannot be processed. + * This includes issues with token structure, encoding, claims, or format. + * + * @category Class + * @package CyberSource\Authentication\Util\JWT + * @author CyberSource + */ +class InvalidJwtException extends JWTException +{ + /** + * Constructor + * + * @param string $message Error message describing the invalid JWT token + * @param Exception|null $cause Optional underlying cause of the error + * @param int $code Optional error code (default: 0) + */ + public function __construct($message = "Invalid JWT token", ?Exception $cause = null, $code = 0) + { + parent::__construct($message, $cause, $code); + } +} + +/** + * JWT Signature Validation Exception + * + * Thrown when JWT signature validation fails. This occurs when the token's + * signature cannot be verified against the expected signing key or algorithm, + * indicating potential token tampering or key mismatch. + * + * @category Class + * @package CyberSource\Authentication\Util\JWT + * @author CyberSource + */ +class JwtSignatureValidationException extends JWTException +{ + /** + * Constructor + * + * @param string $message Error message describing the signature validation failure + * @param Exception|null $cause Optional underlying cause of the error + * @param int $code Optional error code (default: 0) + */ + public function __construct($message = "JWT signature validation failed", ?Exception $cause = null, $code = 0) + { + parent::__construct($message, $cause, $code); + } +} diff --git a/lib/Authentication/Util/JWT/JWTUtility.php b/lib/Authentication/Util/JWT/JWTUtility.php new file mode 100644 index 000000000..c72dad10c --- /dev/null +++ b/lib/Authentication/Util/JWT/JWTUtility.php @@ -0,0 +1,203 @@ + (array)$header, + 'payload' => (array)$payload, + 'signature' => $signature, + // Include raw base64url parts for signature verification + 'rawHeader' => $tokenParts[0], + 'rawPayload' => $tokenParts[1] + ]; + } catch (Exception $err) { + throw new InvalidJwtException('Malformed JWT cannot be parsed: ' . $err->getMessage(), $err); + } + } + + /** + * Verifies a JWT token using an RSA public key + * + * @param string $jwtToken The JWT token to verify + * @param string|array $publicKey The RSA public key (JWK array or JSON string) + * + * @return void + * @throws InvalidJwtException If JWT parsing fails + * @throws JwtSignatureValidationException If signature verification fails + * @throws InvalidJwkException If the public key is invalid + * @throws \JsonException If JSON decoding fails + */ + public static function verifyJwt(string $jwtToken, string|array $publicKey): void + { + // Validate inputs + if (empty($publicKey)) { + throw new JwtSignatureValidationException('No public key found'); + } + + if (empty($jwtToken)) { + throw new JwtSignatureValidationException('JWT token is null or undefined'); + } + + // Parse the JWT token to validate format and extract header + $parsedToken = self::parse($jwtToken); + $header = $parsedToken['header']; + + // Validate algorithm + if (!isset($header['alg'])) { + throw new JwtSignatureValidationException('JWT header missing algorithm (alg) field'); + } + + $algorithm = $header['alg']; + if (!in_array($algorithm, self::SUPPORTED_ALGORITHMS)) { + $supportedAlgs = implode(', ', self::SUPPORTED_ALGORITHMS); + throw new JwtSignatureValidationException( + sprintf('Unsupported JWT algorithm: %s. Supported algorithms: %s', $algorithm, $supportedAlgs) + ); + } + + // Validate and parse the JWK public key + $jwkKey = self::validateAndParseJwk($publicKey); + + // Ensure JWK has the algorithm set (required by firebase/php-jwt) + if (!isset($jwkKey['alg'])) { + $jwkKey['alg'] = $algorithm; + } + + try { + // Use firebase/php-jwt to verify the JWT + // parseKeySet expects an array with a 'keys' element containing an array of JWKs + $jwkSet = ['keys' => [$jwkKey]]; + $keys = JWK::parseKeySet($jwkSet); + + // Decode will throw exception if signature verification fails + JWT::decode($jwtToken, $keys); + + } catch (\Firebase\JWT\SignatureInvalidException $e) { + throw new JwtSignatureValidationException('JWT signature verification failed', $e); + } catch (\Firebase\JWT\BeforeValidException $e) { + throw new JwtSignatureValidationException('JWT not yet valid (nbf claim)', $e); + } catch (\Firebase\JWT\ExpiredException $e) { + throw new JwtSignatureValidationException('JWT has expired (exp claim)', $e); + } catch (\UnexpectedValueException $e) { + throw new JwtSignatureValidationException('JWT verification failed: ' . $e->getMessage(), $e); + } catch (JwtSignatureValidationException | InvalidJwtException $e) { + throw $e; + } catch (Exception $e) { + throw new JwtSignatureValidationException('JWT verification failed: ' . $e->getMessage(), $e); + } + } + + /** + * Extracts an RSA public key from a JWK JSON string + * + * @param string $jwkJsonString The JWK JSON string containing the RSA key + * + * @return array The RSA public key array + * @throws InvalidJwkException If the JWK is invalid or not an RSA key + * @throws \JsonException If JSON decoding fails + */ + public static function getRSAPublicKeyFromJwk(string $jwkJsonString): array + { + return self::validateAndParseJwk($jwkJsonString); + } +} diff --git a/lib/Model/CreatePlanRequest.php b/lib/Model/CreatePlanRequest.php index 793090c57..bb0aaac12 100644 --- a/lib/Model/CreatePlanRequest.php +++ b/lib/Model/CreatePlanRequest.php @@ -53,7 +53,6 @@ class CreatePlanRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'clientReferenceInformation' => '\CyberSource\Model\Rbsv1plansClientReferenceInformation', 'planInformation' => '\CyberSource\Model\Rbsv1plansPlanInformation', 'orderInformation' => '\CyberSource\Model\Rbsv1plansOrderInformation' ]; @@ -63,7 +62,6 @@ class CreatePlanRequest implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'clientReferenceInformation' => null, 'planInformation' => null, 'orderInformation' => null ]; @@ -83,7 +81,6 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'clientReferenceInformation' => 'clientReferenceInformation', 'planInformation' => 'planInformation', 'orderInformation' => 'orderInformation' ]; @@ -94,7 +91,6 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'clientReferenceInformation' => 'setClientReferenceInformation', 'planInformation' => 'setPlanInformation', 'orderInformation' => 'setOrderInformation' ]; @@ -105,7 +101,6 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'clientReferenceInformation' => 'getClientReferenceInformation', 'planInformation' => 'getPlanInformation', 'orderInformation' => 'getOrderInformation' ]; @@ -141,7 +136,6 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; $this->container['planInformation'] = isset($data['planInformation']) ? $data['planInformation'] : null; $this->container['orderInformation'] = isset($data['orderInformation']) ? $data['orderInformation'] : null; } @@ -171,27 +165,6 @@ public function valid() } - /** - * Gets clientReferenceInformation - * @return \CyberSource\Model\Rbsv1plansClientReferenceInformation - */ - public function getClientReferenceInformation() - { - return $this->container['clientReferenceInformation']; - } - - /** - * Sets clientReferenceInformation - * @param \CyberSource\Model\Rbsv1plansClientReferenceInformation $clientReferenceInformation - * @return $this - */ - public function setClientReferenceInformation($clientReferenceInformation) - { - $this->container['clientReferenceInformation'] = $clientReferenceInformation; - - return $this; - } - /** * Gets planInformation * @return \CyberSource\Model\Rbsv1plansPlanInformation diff --git a/lib/Model/CreateSubscriptionRequest.php b/lib/Model/CreateSubscriptionRequest.php index 7d6fbba06..f0079c9ee 100644 --- a/lib/Model/CreateSubscriptionRequest.php +++ b/lib/Model/CreateSubscriptionRequest.php @@ -53,7 +53,7 @@ class CreateSubscriptionRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'clientReferenceInformation' => '\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation', + 'clientReferenceInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation', 'processingInformation' => '\CyberSource\Model\Rbsv1subscriptionsProcessingInformation', 'planInformation' => '\CyberSource\Model\Rbsv1subscriptionsPlanInformation', 'subscriptionInformation' => '\CyberSource\Model\Rbsv1subscriptionsSubscriptionInformation', @@ -191,7 +191,7 @@ public function valid() /** * Gets clientReferenceInformation - * @return \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation + * @return \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation */ public function getClientReferenceInformation() { @@ -200,7 +200,7 @@ public function getClientReferenceInformation() /** * Sets clientReferenceInformation - * @param \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation $clientReferenceInformation + * @param \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation $clientReferenceInformation * @return $this */ public function setClientReferenceInformation($clientReferenceInformation) diff --git a/lib/Model/CreateSubscriptionRequest1.php b/lib/Model/CreateSubscriptionRequest1.php index 750845452..549241469 100644 --- a/lib/Model/CreateSubscriptionRequest1.php +++ b/lib/Model/CreateSubscriptionRequest1.php @@ -53,7 +53,7 @@ class CreateSubscriptionRequest1 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'clientReferenceInformation' => '\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation', + 'clientReferenceInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation', 'processingInformation' => '\CyberSource\Model\Rbsv1subscriptionsProcessingInformation', 'planInformation' => '\CyberSource\Model\Rbsv1subscriptionsPlanInformation', 'subscriptionInformation' => '\CyberSource\Model\Rbsv1subscriptionsSubscriptionInformation', @@ -185,7 +185,7 @@ public function valid() /** * Gets clientReferenceInformation - * @return \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation + * @return \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation */ public function getClientReferenceInformation() { @@ -194,7 +194,7 @@ public function getClientReferenceInformation() /** * Sets clientReferenceInformation - * @param \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation $clientReferenceInformation + * @param \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation $clientReferenceInformation * @return $this */ public function setClientReferenceInformation($clientReferenceInformation) diff --git a/lib/Model/CreateSubscriptionResponse.php b/lib/Model/CreateSubscriptionResponse.php index 59aea9b0f..b68aed614 100644 --- a/lib/Model/CreateSubscriptionResponse.php +++ b/lib/Model/CreateSubscriptionResponse.php @@ -57,7 +57,8 @@ class CreateSubscriptionResponse implements ArrayAccess 'id' => 'string', 'submitTimeUtc' => 'string', 'status' => 'string', - 'subscriptionInformation' => '\CyberSource\Model\CreateSubscriptionResponseSubscriptionInformation' + 'subscriptionInformation' => '\CyberSource\Model\CreateSubscriptionResponseSubscriptionInformation', + 'clientReferenceInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation' ]; /** @@ -69,7 +70,8 @@ class CreateSubscriptionResponse implements ArrayAccess 'id' => null, 'submitTimeUtc' => null, 'status' => null, - 'subscriptionInformation' => null + 'subscriptionInformation' => null, + 'clientReferenceInformation' => null ]; public static function swaggerTypes() @@ -91,7 +93,8 @@ public static function swaggerFormats() 'id' => 'id', 'submitTimeUtc' => 'submitTimeUtc', 'status' => 'status', - 'subscriptionInformation' => 'subscriptionInformation' + 'subscriptionInformation' => 'subscriptionInformation', + 'clientReferenceInformation' => 'clientReferenceInformation' ]; @@ -104,7 +107,8 @@ public static function swaggerFormats() 'id' => 'setId', 'submitTimeUtc' => 'setSubmitTimeUtc', 'status' => 'setStatus', - 'subscriptionInformation' => 'setSubscriptionInformation' + 'subscriptionInformation' => 'setSubscriptionInformation', + 'clientReferenceInformation' => 'setClientReferenceInformation' ]; @@ -117,7 +121,8 @@ public static function swaggerFormats() 'id' => 'getId', 'submitTimeUtc' => 'getSubmitTimeUtc', 'status' => 'getStatus', - 'subscriptionInformation' => 'getSubscriptionInformation' + 'subscriptionInformation' => 'getSubscriptionInformation', + 'clientReferenceInformation' => 'getClientReferenceInformation' ]; public static function attributeMap() @@ -156,6 +161,7 @@ public function __construct(array $data = null) $this->container['submitTimeUtc'] = isset($data['submitTimeUtc']) ? $data['submitTimeUtc'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['subscriptionInformation'] = isset($data['subscriptionInformation']) ? $data['subscriptionInformation'] : null; + $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; } /** @@ -287,6 +293,27 @@ public function setSubscriptionInformation($subscriptionInformation) return $this; } + + /** + * Gets clientReferenceInformation + * @return \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation + */ + public function getClientReferenceInformation() + { + return $this->container['clientReferenceInformation']; + } + + /** + * Sets clientReferenceInformation + * @param \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation $clientReferenceInformation + * @return $this + */ + public function setClientReferenceInformation($clientReferenceInformation) + { + $this->container['clientReferenceInformation'] = $clientReferenceInformation; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/GenerateUnifiedCheckoutCaptureContextRequest.php b/lib/Model/GenerateUnifiedCheckoutCaptureContextRequest.php index ba34a0969..5f47929f5 100644 --- a/lib/Model/GenerateUnifiedCheckoutCaptureContextRequest.php +++ b/lib/Model/GenerateUnifiedCheckoutCaptureContextRequest.php @@ -59,6 +59,7 @@ class GenerateUnifiedCheckoutCaptureContextRequest implements ArrayAccess 'allowedPaymentTypes' => 'string[]', 'country' => 'string', 'locale' => 'string', + 'buttonType' => 'string', 'captureMandate' => '\CyberSource\Model\Upv1capturecontextsCaptureMandate', 'completeMandate' => '\CyberSource\Model\Upv1capturecontextsCompleteMandate', 'transientTokenResponseOptions' => '\CyberSource\Model\Microformv2sessionsTransientTokenResponseOptions', @@ -77,6 +78,7 @@ class GenerateUnifiedCheckoutCaptureContextRequest implements ArrayAccess 'allowedPaymentTypes' => null, 'country' => null, 'locale' => null, + 'buttonType' => null, 'captureMandate' => null, 'completeMandate' => null, 'transientTokenResponseOptions' => null, @@ -105,6 +107,7 @@ public static function swaggerFormats() 'allowedPaymentTypes' => 'allowedPaymentTypes', 'country' => 'country', 'locale' => 'locale', + 'buttonType' => 'buttonType', 'captureMandate' => 'captureMandate', 'completeMandate' => 'completeMandate', 'transientTokenResponseOptions' => 'transientTokenResponseOptions', @@ -124,6 +127,7 @@ public static function swaggerFormats() 'allowedPaymentTypes' => 'setAllowedPaymentTypes', 'country' => 'setCountry', 'locale' => 'setLocale', + 'buttonType' => 'setButtonType', 'captureMandate' => 'setCaptureMandate', 'completeMandate' => 'setCompleteMandate', 'transientTokenResponseOptions' => 'setTransientTokenResponseOptions', @@ -143,6 +147,7 @@ public static function swaggerFormats() 'allowedPaymentTypes' => 'getAllowedPaymentTypes', 'country' => 'getCountry', 'locale' => 'getLocale', + 'buttonType' => 'getButtonType', 'captureMandate' => 'getCaptureMandate', 'completeMandate' => 'getCompleteMandate', 'transientTokenResponseOptions' => 'getTransientTokenResponseOptions', @@ -187,6 +192,7 @@ public function __construct(array $data = null) $this->container['allowedPaymentTypes'] = isset($data['allowedPaymentTypes']) ? $data['allowedPaymentTypes'] : null; $this->container['country'] = isset($data['country']) ? $data['country'] : null; $this->container['locale'] = isset($data['locale']) ? $data['locale'] : null; + $this->container['buttonType'] = isset($data['buttonType']) ? $data['buttonType'] : null; $this->container['captureMandate'] = isset($data['captureMandate']) ? $data['captureMandate'] : null; $this->container['completeMandate'] = isset($data['completeMandate']) ? $data['completeMandate'] : null; $this->container['transientTokenResponseOptions'] = isset($data['transientTokenResponseOptions']) ? $data['transientTokenResponseOptions'] : null; @@ -293,7 +299,7 @@ public function getAllowedPaymentTypes() /** * Sets allowedPaymentTypes - * @param string[] $allowedPaymentTypes The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE

Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY

Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB) Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY

**Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

**Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

**Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa

If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. + * @param string[] $allowedPaymentTypes The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE

Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY

Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB)

Unified Checkout supports the following Post-Pay Reference payment methods: - Konbini (JP)

Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY

**Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.

**Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.

**Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa

If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. * @return $this */ public function setAllowedPaymentTypes($allowedPaymentTypes) @@ -345,6 +351,27 @@ public function setLocale($locale) return $this; } + /** + * Gets buttonType + * @return string + */ + public function getButtonType() + { + return $this->container['buttonType']; + } + + /** + * Sets buttonType + * @param string $buttonType Changes the label on the payment button within Unified Checkout .

Possible values: - ADD_CARD - CARD_PAYMENT - CHECKOUT - CHECKOUT_AND_CONTINUE - DEBIT_CREDIT - DONATE - PAY - PAY_WITH_CARD - SAVE_CARD - SUBSCRIBE_WITH_CARD

This is an optional field, + * @return $this + */ + public function setButtonType($buttonType) + { + $this->container['buttonType'] = $buttonType; + + return $this; + } + /** * Gets captureMandate * @return \CyberSource\Model\Upv1capturecontextsCaptureMandate diff --git a/lib/Model/GetAllSubscriptionsResponseClientReferenceInformation.php b/lib/Model/GetAllSubscriptionsResponseClientReferenceInformation.php new file mode 100644 index 000000000..f4ac66eaf --- /dev/null +++ b/lib/Model/GetAllSubscriptionsResponseClientReferenceInformation.php @@ -0,0 +1,245 @@ + 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'code' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'code' => 'code' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'code' => 'setCode' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'code' => 'getCode' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['code'] = isset($data['code']) ? $data['code'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets code + * @return string + */ + public function getCode() + { + return $this->container['code']; + } + + /** + * Sets code + * @param string $code Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. + * @return $this + */ + public function setCode($code) + { + $this->container['code'] = $code; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/GetAllSubscriptionsResponseSubscriptions.php b/lib/Model/GetAllSubscriptionsResponseSubscriptions.php index 393ab54ce..db790ae05 100644 --- a/lib/Model/GetAllSubscriptionsResponseSubscriptions.php +++ b/lib/Model/GetAllSubscriptionsResponseSubscriptions.php @@ -58,6 +58,7 @@ class GetAllSubscriptionsResponseSubscriptions implements ArrayAccess 'id' => 'string', 'planInformation' => '\CyberSource\Model\GetAllSubscriptionsResponsePlanInformation', 'subscriptionInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseSubscriptionInformation', + 'clientReferenceInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation', 'paymentInformation' => '\CyberSource\Model\GetAllSubscriptionsResponsePaymentInformation', 'orderInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseOrderInformation' ]; @@ -71,6 +72,7 @@ class GetAllSubscriptionsResponseSubscriptions implements ArrayAccess 'id' => null, 'planInformation' => null, 'subscriptionInformation' => null, + 'clientReferenceInformation' => null, 'paymentInformation' => null, 'orderInformation' => null ]; @@ -94,6 +96,7 @@ public static function swaggerFormats() 'id' => 'id', 'planInformation' => 'planInformation', 'subscriptionInformation' => 'subscriptionInformation', + 'clientReferenceInformation' => 'clientReferenceInformation', 'paymentInformation' => 'paymentInformation', 'orderInformation' => 'orderInformation' ]; @@ -108,6 +111,7 @@ public static function swaggerFormats() 'id' => 'setId', 'planInformation' => 'setPlanInformation', 'subscriptionInformation' => 'setSubscriptionInformation', + 'clientReferenceInformation' => 'setClientReferenceInformation', 'paymentInformation' => 'setPaymentInformation', 'orderInformation' => 'setOrderInformation' ]; @@ -122,6 +126,7 @@ public static function swaggerFormats() 'id' => 'getId', 'planInformation' => 'getPlanInformation', 'subscriptionInformation' => 'getSubscriptionInformation', + 'clientReferenceInformation' => 'getClientReferenceInformation', 'paymentInformation' => 'getPaymentInformation', 'orderInformation' => 'getOrderInformation' ]; @@ -161,6 +166,7 @@ public function __construct(array $data = null) $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['planInformation'] = isset($data['planInformation']) ? $data['planInformation'] : null; $this->container['subscriptionInformation'] = isset($data['subscriptionInformation']) ? $data['subscriptionInformation'] : null; + $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; $this->container['paymentInformation'] = isset($data['paymentInformation']) ? $data['paymentInformation'] : null; $this->container['orderInformation'] = isset($data['orderInformation']) ? $data['orderInformation'] : null; } @@ -274,6 +280,27 @@ public function setSubscriptionInformation($subscriptionInformation) return $this; } + /** + * Gets clientReferenceInformation + * @return \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation + */ + public function getClientReferenceInformation() + { + return $this->container['clientReferenceInformation']; + } + + /** + * Sets clientReferenceInformation + * @param \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation $clientReferenceInformation + * @return $this + */ + public function setClientReferenceInformation($clientReferenceInformation) + { + $this->container['clientReferenceInformation'] = $clientReferenceInformation; + + return $this; + } + /** * Gets paymentInformation * @return \CyberSource\Model\GetAllSubscriptionsResponsePaymentInformation diff --git a/lib/Model/GetSubscriptionResponse.php b/lib/Model/GetSubscriptionResponse.php index 7d8a53e75..3cf0eab50 100644 --- a/lib/Model/GetSubscriptionResponse.php +++ b/lib/Model/GetSubscriptionResponse.php @@ -60,6 +60,7 @@ class GetSubscriptionResponse implements ArrayAccess 'subscriptionInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseSubscriptionInformation', 'paymentInformation' => '\CyberSource\Model\GetAllSubscriptionsResponsePaymentInformation', 'orderInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseOrderInformation', + 'clientReferenceInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation', 'reactivationInformation' => '\CyberSource\Model\GetSubscriptionResponseReactivationInformation' ]; @@ -75,6 +76,7 @@ class GetSubscriptionResponse implements ArrayAccess 'subscriptionInformation' => null, 'paymentInformation' => null, 'orderInformation' => null, + 'clientReferenceInformation' => null, 'reactivationInformation' => null ]; @@ -100,6 +102,7 @@ public static function swaggerFormats() 'subscriptionInformation' => 'subscriptionInformation', 'paymentInformation' => 'paymentInformation', 'orderInformation' => 'orderInformation', + 'clientReferenceInformation' => 'clientReferenceInformation', 'reactivationInformation' => 'reactivationInformation' ]; @@ -116,6 +119,7 @@ public static function swaggerFormats() 'subscriptionInformation' => 'setSubscriptionInformation', 'paymentInformation' => 'setPaymentInformation', 'orderInformation' => 'setOrderInformation', + 'clientReferenceInformation' => 'setClientReferenceInformation', 'reactivationInformation' => 'setReactivationInformation' ]; @@ -132,6 +136,7 @@ public static function swaggerFormats() 'subscriptionInformation' => 'getSubscriptionInformation', 'paymentInformation' => 'getPaymentInformation', 'orderInformation' => 'getOrderInformation', + 'clientReferenceInformation' => 'getClientReferenceInformation', 'reactivationInformation' => 'getReactivationInformation' ]; @@ -173,6 +178,7 @@ public function __construct(array $data = null) $this->container['subscriptionInformation'] = isset($data['subscriptionInformation']) ? $data['subscriptionInformation'] : null; $this->container['paymentInformation'] = isset($data['paymentInformation']) ? $data['paymentInformation'] : null; $this->container['orderInformation'] = isset($data['orderInformation']) ? $data['orderInformation'] : null; + $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; $this->container['reactivationInformation'] = isset($data['reactivationInformation']) ? $data['reactivationInformation'] : null; } @@ -348,6 +354,27 @@ public function setOrderInformation($orderInformation) return $this; } + /** + * Gets clientReferenceInformation + * @return \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation + */ + public function getClientReferenceInformation() + { + return $this->container['clientReferenceInformation']; + } + + /** + * Sets clientReferenceInformation + * @param \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation $clientReferenceInformation + * @return $this + */ + public function setClientReferenceInformation($clientReferenceInformation) + { + $this->container['clientReferenceInformation'] = $clientReferenceInformation; + + return $this; + } + /** * Gets reactivationInformation * @return \CyberSource\Model\GetSubscriptionResponseReactivationInformation diff --git a/lib/Model/GetSubscriptionResponse1PaymentInstrument.php b/lib/Model/GetSubscriptionResponse1PaymentInstrument.php index b3f6e85b7..349b46ee3 100644 --- a/lib/Model/GetSubscriptionResponse1PaymentInstrument.php +++ b/lib/Model/GetSubscriptionResponse1PaymentInstrument.php @@ -57,7 +57,7 @@ class GetSubscriptionResponse1PaymentInstrument implements ArrayAccess 'id' => 'string', 'bankAccount' => '\CyberSource\Model\GetSubscriptionResponse1PaymentInstrumentBankAccount', 'card' => '\CyberSource\Model\GetSubscriptionResponse1PaymentInstrumentCard', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'buyerInformation' => '\CyberSource\Model\GetSubscriptionResponse1PaymentInstrumentBuyerInformation' ]; @@ -249,7 +249,7 @@ public function setCard($card) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -258,7 +258,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) diff --git a/lib/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.php b/lib/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.php index 5c51c4e8b..8a9841251 100644 --- a/lib/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.php +++ b/lib/Model/GetSubscriptionResponse1PaymentInstrumentBuyerInformation.php @@ -56,7 +56,7 @@ class GetSubscriptionResponse1PaymentInstrumentBuyerInformation implements Array 'companyTaxID' => 'string', 'currency' => 'string', 'dateOfBirth' => '\DateTime', - 'personalIdentification' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]' + 'personalIdentification' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]' ]; /** @@ -242,7 +242,7 @@ public function setDateOfBirth($dateOfBirth) /** * Gets personalIdentification - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] */ public function getPersonalIdentification() { @@ -251,7 +251,7 @@ public function getPersonalIdentification() /** * Sets personalIdentification - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] $personalIdentification + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] $personalIdentification * @return $this */ public function setPersonalIdentification($personalIdentification) diff --git a/lib/Model/GetSubscriptionResponse1ShippingAddress.php b/lib/Model/GetSubscriptionResponse1ShippingAddress.php index dd0d62a8c..2887c2b7d 100644 --- a/lib/Model/GetSubscriptionResponse1ShippingAddress.php +++ b/lib/Model/GetSubscriptionResponse1ShippingAddress.php @@ -55,7 +55,7 @@ class GetSubscriptionResponse1ShippingAddress implements ArrayAccess */ protected static $swaggerTypes = [ 'id' => 'string', - 'shipTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo' + 'shipTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo' ]; /** @@ -189,7 +189,7 @@ public function setId($id) /** * Gets shipTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo */ public function getShipTo() { @@ -198,7 +198,7 @@ public function getShipTo() /** * Sets shipTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo $shipTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo $shipTo * @return $this */ public function setShipTo($shipTo) diff --git a/lib/Model/GetSubscriptionResponseReactivationInformation.php b/lib/Model/GetSubscriptionResponseReactivationInformation.php index 71cdf0248..8bb2de583 100644 --- a/lib/Model/GetSubscriptionResponseReactivationInformation.php +++ b/lib/Model/GetSubscriptionResponseReactivationInformation.php @@ -53,8 +53,8 @@ class GetSubscriptionResponseReactivationInformation implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'skippedPaymentsCount' => 'string', - 'skippedPaymentsTotalAmount' => 'string' + 'missedPaymentsCount' => 'string', + 'missedPaymentsTotalAmount' => 'string' ]; /** @@ -62,8 +62,8 @@ class GetSubscriptionResponseReactivationInformation implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'skippedPaymentsCount' => null, - 'skippedPaymentsTotalAmount' => null + 'missedPaymentsCount' => null, + 'missedPaymentsTotalAmount' => null ]; public static function swaggerTypes() @@ -81,8 +81,8 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'skippedPaymentsCount' => 'skippedPaymentsCount', - 'skippedPaymentsTotalAmount' => 'skippedPaymentsTotalAmount' + 'missedPaymentsCount' => 'missedPaymentsCount', + 'missedPaymentsTotalAmount' => 'missedPaymentsTotalAmount' ]; @@ -91,8 +91,8 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'skippedPaymentsCount' => 'setSkippedPaymentsCount', - 'skippedPaymentsTotalAmount' => 'setSkippedPaymentsTotalAmount' + 'missedPaymentsCount' => 'setMissedPaymentsCount', + 'missedPaymentsTotalAmount' => 'setMissedPaymentsTotalAmount' ]; @@ -101,8 +101,8 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'skippedPaymentsCount' => 'getSkippedPaymentsCount', - 'skippedPaymentsTotalAmount' => 'getSkippedPaymentsTotalAmount' + 'missedPaymentsCount' => 'getMissedPaymentsCount', + 'missedPaymentsTotalAmount' => 'getMissedPaymentsTotalAmount' ]; public static function attributeMap() @@ -136,8 +136,8 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['skippedPaymentsCount'] = isset($data['skippedPaymentsCount']) ? $data['skippedPaymentsCount'] : null; - $this->container['skippedPaymentsTotalAmount'] = isset($data['skippedPaymentsTotalAmount']) ? $data['skippedPaymentsTotalAmount'] : null; + $this->container['missedPaymentsCount'] = isset($data['missedPaymentsCount']) ? $data['missedPaymentsCount'] : null; + $this->container['missedPaymentsTotalAmount'] = isset($data['missedPaymentsTotalAmount']) ? $data['missedPaymentsTotalAmount'] : null; } /** @@ -166,43 +166,43 @@ public function valid() /** - * Gets skippedPaymentsCount + * Gets missedPaymentsCount * @return string */ - public function getSkippedPaymentsCount() + public function getMissedPaymentsCount() { - return $this->container['skippedPaymentsCount']; + return $this->container['missedPaymentsCount']; } /** - * Sets skippedPaymentsCount - * @param string $skippedPaymentsCount Number of payments that should have occurred while the subscription was in a suspended status. + * Sets missedPaymentsCount + * @param string $missedPaymentsCount Number of payments that should have occurred while the subscription was in a suspended status. * @return $this */ - public function setSkippedPaymentsCount($skippedPaymentsCount) + public function setMissedPaymentsCount($missedPaymentsCount) { - $this->container['skippedPaymentsCount'] = $skippedPaymentsCount; + $this->container['missedPaymentsCount'] = $missedPaymentsCount; return $this; } /** - * Gets skippedPaymentsTotalAmount + * Gets missedPaymentsTotalAmount * @return string */ - public function getSkippedPaymentsTotalAmount() + public function getMissedPaymentsTotalAmount() { - return $this->container['skippedPaymentsTotalAmount']; + return $this->container['missedPaymentsTotalAmount']; } /** - * Sets skippedPaymentsTotalAmount - * @param string $skippedPaymentsTotalAmount Total amount that will be charged upon reactivation if `processSkippedPayments` is set to `true`. + * Sets missedPaymentsTotalAmount + * @param string $missedPaymentsTotalAmount Total amount that will be charged upon reactivation if `processMissedPayments` is set to `true`. * @return $this */ - public function setSkippedPaymentsTotalAmount($skippedPaymentsTotalAmount) + public function setMissedPaymentsTotalAmount($missedPaymentsTotalAmount) { - $this->container['skippedPaymentsTotalAmount'] = $skippedPaymentsTotalAmount; + $this->container['missedPaymentsTotalAmount'] = $missedPaymentsTotalAmount; return $this; } diff --git a/lib/Model/InlineResponse200.php b/lib/Model/InlineResponse200.php index df93c8284..af4041aac 100644 --- a/lib/Model/InlineResponse200.php +++ b/lib/Model/InlineResponse200.php @@ -34,7 +34,6 @@ * InlineResponse200 Class Doc Comment * * @category Class - * @description Represents the Card Art Asset associated to the Network Token. * @package CyberSource * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen @@ -54,10 +53,7 @@ class InlineResponse200 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'id' => 'string', - 'type' => 'string', - 'provider' => 'string', - 'content' => '\CyberSource\Model\InlineResponse200Content[]' + 'responses' => '\CyberSource\Model\InlineResponse200Responses[]' ]; /** @@ -65,10 +61,7 @@ class InlineResponse200 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'id' => null, - 'type' => null, - 'provider' => null, - 'content' => null + 'responses' => null ]; public static function swaggerTypes() @@ -86,10 +79,7 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'id' => 'id', - 'type' => 'type', - 'provider' => 'provider', - 'content' => 'content' + 'responses' => 'responses' ]; @@ -98,10 +88,7 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'id' => 'setId', - 'type' => 'setType', - 'provider' => 'setProvider', - 'content' => 'setContent' + 'responses' => 'setResponses' ]; @@ -110,10 +97,7 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'id' => 'getId', - 'type' => 'getType', - 'provider' => 'getProvider', - 'content' => 'getContent' + 'responses' => 'getResponses' ]; public static function attributeMap() @@ -147,10 +131,7 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['id'] = isset($data['id']) ? $data['id'] : null; - $this->container['type'] = isset($data['type']) ? $data['type'] : null; - $this->container['provider'] = isset($data['provider']) ? $data['provider'] : null; - $this->container['content'] = isset($data['content']) ? $data['content'] : null; + $this->container['responses'] = isset($data['responses']) ? $data['responses'] : null; } /** @@ -179,85 +160,22 @@ public function valid() /** - * Gets id - * @return string - */ - public function getId() - { - return $this->container['id']; - } - - /** - * Sets id - * @param string $id Unique identifier for the Card Art Asset. - * @return $this - */ - public function setId($id) - { - $this->container['id'] = $id; - - return $this; - } - - /** - * Gets type - * @return string - */ - public function getType() - { - return $this->container['type']; - } - - /** - * Sets type - * @param string $type The type of Card Art Asset. - * @return $this - */ - public function setType($type) - { - $this->container['type'] = $type; - - return $this; - } - - /** - * Gets provider - * @return string - */ - public function getProvider() - { - return $this->container['provider']; - } - - /** - * Sets provider - * @param string $provider The provider of the Card Art Asset. - * @return $this - */ - public function setProvider($provider) - { - $this->container['provider'] = $provider; - - return $this; - } - - /** - * Gets content - * @return \CyberSource\Model\InlineResponse200Content[] + * Gets responses + * @return \CyberSource\Model\InlineResponse200Responses[] */ - public function getContent() + public function getResponses() { - return $this->container['content']; + return $this->container['responses']; } /** - * Sets content - * @param \CyberSource\Model\InlineResponse200Content[] $content Array of content objects representing the Card Art Asset. + * Sets responses + * @param \CyberSource\Model\InlineResponse200Responses[] $responses * @return $this */ - public function setContent($content) + public function setResponses($responses) { - $this->container['content'] = $content; + $this->container['responses'] = $responses; return $this; } diff --git a/lib/Model/InlineResponse2001.php b/lib/Model/InlineResponse2001.php index 38160a732..f578396c3 100644 --- a/lib/Model/InlineResponse2001.php +++ b/lib/Model/InlineResponse2001.php @@ -34,6 +34,7 @@ * InlineResponse2001 Class Doc Comment * * @category Class + * @description Represents the Card Art Asset associated to the Network Token. * @package CyberSource * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen @@ -54,9 +55,9 @@ class InlineResponse2001 implements ArrayAccess */ protected static $swaggerTypes = [ 'id' => 'string', - 'submitTimeUtc' => 'string', - 'status' => 'string', - 'embedded' => '\CyberSource\Model\InlineResponse2001Embedded' + 'type' => 'string', + 'provider' => 'string', + 'content' => '\CyberSource\Model\InlineResponse2001Content[]' ]; /** @@ -65,9 +66,9 @@ class InlineResponse2001 implements ArrayAccess */ protected static $swaggerFormats = [ 'id' => null, - 'submitTimeUtc' => null, - 'status' => null, - 'embedded' => null + 'type' => null, + 'provider' => null, + 'content' => null ]; public static function swaggerTypes() @@ -86,9 +87,9 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'id' => 'id', - 'submitTimeUtc' => 'submitTimeUtc', - 'status' => 'status', - 'embedded' => '_embedded' + 'type' => 'type', + 'provider' => 'provider', + 'content' => 'content' ]; @@ -98,9 +99,9 @@ public static function swaggerFormats() */ protected static $setters = [ 'id' => 'setId', - 'submitTimeUtc' => 'setSubmitTimeUtc', - 'status' => 'setStatus', - 'embedded' => 'setEmbedded' + 'type' => 'setType', + 'provider' => 'setProvider', + 'content' => 'setContent' ]; @@ -110,9 +111,9 @@ public static function swaggerFormats() */ protected static $getters = [ 'id' => 'getId', - 'submitTimeUtc' => 'getSubmitTimeUtc', - 'status' => 'getStatus', - 'embedded' => 'getEmbedded' + 'type' => 'getType', + 'provider' => 'getProvider', + 'content' => 'getContent' ]; public static function attributeMap() @@ -147,9 +148,9 @@ public static function getters() public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; - $this->container['submitTimeUtc'] = isset($data['submitTimeUtc']) ? $data['submitTimeUtc'] : null; - $this->container['status'] = isset($data['status']) ? $data['status'] : null; - $this->container['embedded'] = isset($data['embedded']) ? $data['embedded'] : null; + $this->container['type'] = isset($data['type']) ? $data['type'] : null; + $this->container['provider'] = isset($data['provider']) ? $data['provider'] : null; + $this->container['content'] = isset($data['content']) ? $data['content'] : null; } /** @@ -188,7 +189,7 @@ public function getId() /** * Sets id - * @param string $id UUID uniquely generated for this comments. + * @param string $id Unique identifier for the Card Art Asset. * @return $this */ public function setId($id) @@ -199,64 +200,64 @@ public function setId($id) } /** - * Gets submitTimeUtc + * Gets type * @return string */ - public function getSubmitTimeUtc() + public function getType() { - return $this->container['submitTimeUtc']; + return $this->container['type']; } /** - * Sets submitTimeUtc - * @param string $submitTimeUtc Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. + * Sets type + * @param string $type The type of Card Art Asset. * @return $this */ - public function setSubmitTimeUtc($submitTimeUtc) + public function setType($type) { - $this->container['submitTimeUtc'] = $submitTimeUtc; + $this->container['type'] = $type; return $this; } /** - * Gets status + * Gets provider * @return string */ - public function getStatus() + public function getProvider() { - return $this->container['status']; + return $this->container['provider']; } /** - * Sets status - * @param string $status The status of the submitted transaction. Possible values are: - `ACCEPTED` - `REJECTED` + * Sets provider + * @param string $provider The provider of the Card Art Asset. * @return $this */ - public function setStatus($status) + public function setProvider($provider) { - $this->container['status'] = $status; + $this->container['provider'] = $provider; return $this; } /** - * Gets embedded - * @return \CyberSource\Model\InlineResponse2001Embedded + * Gets content + * @return \CyberSource\Model\InlineResponse2001Content[] */ - public function getEmbedded() + public function getContent() { - return $this->container['embedded']; + return $this->container['content']; } /** - * Sets embedded - * @param \CyberSource\Model\InlineResponse2001Embedded $embedded + * Sets content + * @param \CyberSource\Model\InlineResponse2001Content[] $content Array of content objects representing the Card Art Asset. * @return $this */ - public function setEmbedded($embedded) + public function setContent($content) { - $this->container['embedded'] = $embedded; + $this->container['content'] = $content; return $this; } diff --git a/lib/Model/InlineResponse20010.php b/lib/Model/InlineResponse20010.php index fb7a43a53..21adfc3a7 100644 --- a/lib/Model/InlineResponse20010.php +++ b/lib/Model/InlineResponse20010.php @@ -53,13 +53,12 @@ class InlineResponse20010 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\InlineResponse20010Links[]', - 'object' => 'string', + 'totalCount' => 'int', 'offset' => 'int', 'limit' => 'int', + 'sort' => 'string', 'count' => 'int', - 'total' => 'int', - 'embedded' => '\CyberSource\Model\InlineResponse20010Embedded' + 'devices' => '\CyberSource\Model\InlineResponse20010Devices[]' ]; /** @@ -67,13 +66,12 @@ class InlineResponse20010 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'links' => null, - 'object' => null, + 'totalCount' => null, 'offset' => null, 'limit' => null, + 'sort' => null, 'count' => null, - 'total' => null, - 'embedded' => null + 'devices' => null ]; public static function swaggerTypes() @@ -91,13 +89,12 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'links' => '_links', - 'object' => 'object', + 'totalCount' => 'totalCount', 'offset' => 'offset', 'limit' => 'limit', + 'sort' => 'sort', 'count' => 'count', - 'total' => 'total', - 'embedded' => '_embedded' + 'devices' => 'devices' ]; @@ -106,13 +103,12 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'links' => 'setLinks', - 'object' => 'setObject', + 'totalCount' => 'setTotalCount', 'offset' => 'setOffset', 'limit' => 'setLimit', + 'sort' => 'setSort', 'count' => 'setCount', - 'total' => 'setTotal', - 'embedded' => 'setEmbedded' + 'devices' => 'setDevices' ]; @@ -121,13 +117,12 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'links' => 'getLinks', - 'object' => 'getObject', + 'totalCount' => 'getTotalCount', 'offset' => 'getOffset', 'limit' => 'getLimit', + 'sort' => 'getSort', 'count' => 'getCount', - 'total' => 'getTotal', - 'embedded' => 'getEmbedded' + 'devices' => 'getDevices' ]; public static function attributeMap() @@ -161,13 +156,12 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['links'] = isset($data['links']) ? $data['links'] : null; - $this->container['object'] = isset($data['object']) ? $data['object'] : null; + $this->container['totalCount'] = isset($data['totalCount']) ? $data['totalCount'] : null; $this->container['offset'] = isset($data['offset']) ? $data['offset'] : null; $this->container['limit'] = isset($data['limit']) ? $data['limit'] : null; + $this->container['sort'] = isset($data['sort']) ? $data['sort'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; - $this->container['total'] = isset($data['total']) ? $data['total'] : null; - $this->container['embedded'] = isset($data['embedded']) ? $data['embedded'] : null; + $this->container['devices'] = isset($data['devices']) ? $data['devices'] : null; } /** @@ -196,43 +190,22 @@ public function valid() /** - * Gets links - * @return \CyberSource\Model\InlineResponse20010Links[] - */ - public function getLinks() - { - return $this->container['links']; - } - - /** - * Sets links - * @param \CyberSource\Model\InlineResponse20010Links[] $links - * @return $this - */ - public function setLinks($links) - { - $this->container['links'] = $links; - - return $this; - } - - /** - * Gets object - * @return string + * Gets totalCount + * @return int */ - public function getObject() + public function getTotalCount() { - return $this->container['object']; + return $this->container['totalCount']; } /** - * Sets object - * @param string $object + * Sets totalCount + * @param int $totalCount Total number of results. * @return $this */ - public function setObject($object) + public function setTotalCount($totalCount) { - $this->container['object'] = $object; + $this->container['totalCount'] = $totalCount; return $this; } @@ -248,7 +221,7 @@ public function getOffset() /** * Sets offset - * @param int $offset + * @param int $offset Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. * @return $this */ public function setOffset($offset) @@ -269,7 +242,7 @@ public function getLimit() /** * Sets limit - * @param int $limit + * @param int $limit Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. * @return $this */ public function setLimit($limit) @@ -280,64 +253,64 @@ public function setLimit($limit) } /** - * Gets count - * @return int + * Gets sort + * @return string */ - public function getCount() + public function getSort() { - return $this->container['count']; + return $this->container['sort']; } /** - * Sets count - * @param int $count + * Sets sort + * @param string $sort A comma separated list of the following form: `terminalCreationDate:desc or serialNumber or terminalUpdationDate` * @return $this */ - public function setCount($count) + public function setSort($sort) { - $this->container['count'] = $count; + $this->container['sort'] = $sort; return $this; } /** - * Gets total + * Gets count * @return int */ - public function getTotal() + public function getCount() { - return $this->container['total']; + return $this->container['count']; } /** - * Sets total - * @param int $total + * Sets count + * @param int $count Results for this page, this could be below the limit. * @return $this */ - public function setTotal($total) + public function setCount($count) { - $this->container['total'] = $total; + $this->container['count'] = $count; return $this; } /** - * Gets embedded - * @return \CyberSource\Model\InlineResponse20010Embedded + * Gets devices + * @return \CyberSource\Model\InlineResponse20010Devices[] */ - public function getEmbedded() + public function getDevices() { - return $this->container['embedded']; + return $this->container['devices']; } /** - * Sets embedded - * @param \CyberSource\Model\InlineResponse20010Embedded $embedded + * Sets devices + * @param \CyberSource\Model\InlineResponse20010Devices[] $devices A collection of devices * @return $this */ - public function setEmbedded($embedded) + public function setDevices($devices) { - $this->container['embedded'] = $embedded; + $this->container['devices'] = $devices; return $this; } diff --git a/lib/Model/InlineResponse2009Devices.php b/lib/Model/InlineResponse20010Devices.php similarity index 96% rename from lib/Model/InlineResponse2009Devices.php rename to lib/Model/InlineResponse20010Devices.php index 01f06fe04..97d77cb9b 100644 --- a/lib/Model/InlineResponse2009Devices.php +++ b/lib/Model/InlineResponse20010Devices.php @@ -1,6 +1,6 @@ 'string', 'terminalCreationDate' => '\DateTime', 'terminalUpdationDate' => '\DateTime', - 'paymentProcessorToTerminalMap' => '\CyberSource\Model\InlineResponse2009PaymentProcessorToTerminalMap' + 'paymentProcessorToTerminalMap' => '\CyberSource\Model\InlineResponse20010PaymentProcessorToTerminalMap' ]; /** @@ -458,7 +458,7 @@ public function setTerminalUpdationDate($terminalUpdationDate) /** * Gets paymentProcessorToTerminalMap - * @return \CyberSource\Model\InlineResponse2009PaymentProcessorToTerminalMap + * @return \CyberSource\Model\InlineResponse20010PaymentProcessorToTerminalMap */ public function getPaymentProcessorToTerminalMap() { @@ -467,7 +467,7 @@ public function getPaymentProcessorToTerminalMap() /** * Sets paymentProcessorToTerminalMap - * @param \CyberSource\Model\InlineResponse2009PaymentProcessorToTerminalMap $paymentProcessorToTerminalMap + * @param \CyberSource\Model\InlineResponse20010PaymentProcessorToTerminalMap $paymentProcessorToTerminalMap * @return $this */ public function setPaymentProcessorToTerminalMap($paymentProcessorToTerminalMap) diff --git a/lib/Model/InlineResponse2009PaymentProcessorToTerminalMap.php b/lib/Model/InlineResponse20010PaymentProcessorToTerminalMap.php similarity index 95% rename from lib/Model/InlineResponse2009PaymentProcessorToTerminalMap.php rename to lib/Model/InlineResponse20010PaymentProcessorToTerminalMap.php index 725e107b0..a4f63ea16 100644 --- a/lib/Model/InlineResponse2009PaymentProcessorToTerminalMap.php +++ b/lib/Model/InlineResponse20010PaymentProcessorToTerminalMap.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse20011Links', - 'batchId' => 'string', - 'batchCreatedDate' => 'string', - 'batchSource' => 'string', - 'merchantReference' => 'string', - 'batchCaEndpoints' => 'string', - 'status' => 'string', - 'totals' => '\CyberSource\Model\InlineResponse20010EmbeddedTotals', - 'billing' => '\CyberSource\Model\InlineResponse20011Billing', - 'description' => 'string' + 'links' => '\CyberSource\Model\InlineResponse20011Links[]', + 'object' => 'string', + 'offset' => 'int', + 'limit' => 'int', + 'count' => 'int', + 'total' => 'int', + 'embedded' => '\CyberSource\Model\InlineResponse20011Embedded' ]; /** @@ -71,15 +68,12 @@ class InlineResponse20011 implements ArrayAccess */ protected static $swaggerFormats = [ 'links' => null, - 'batchId' => null, - 'batchCreatedDate' => null, - 'batchSource' => null, - 'merchantReference' => null, - 'batchCaEndpoints' => null, - 'status' => null, - 'totals' => null, - 'billing' => null, - 'description' => null + 'object' => null, + 'offset' => null, + 'limit' => null, + 'count' => null, + 'total' => null, + 'embedded' => null ]; public static function swaggerTypes() @@ -98,15 +92,12 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'links' => '_links', - 'batchId' => 'batchId', - 'batchCreatedDate' => 'batchCreatedDate', - 'batchSource' => 'batchSource', - 'merchantReference' => 'merchantReference', - 'batchCaEndpoints' => 'batchCaEndpoints', - 'status' => 'status', - 'totals' => 'totals', - 'billing' => 'billing', - 'description' => 'description' + 'object' => 'object', + 'offset' => 'offset', + 'limit' => 'limit', + 'count' => 'count', + 'total' => 'total', + 'embedded' => '_embedded' ]; @@ -116,15 +107,12 @@ public static function swaggerFormats() */ protected static $setters = [ 'links' => 'setLinks', - 'batchId' => 'setBatchId', - 'batchCreatedDate' => 'setBatchCreatedDate', - 'batchSource' => 'setBatchSource', - 'merchantReference' => 'setMerchantReference', - 'batchCaEndpoints' => 'setBatchCaEndpoints', - 'status' => 'setStatus', - 'totals' => 'setTotals', - 'billing' => 'setBilling', - 'description' => 'setDescription' + 'object' => 'setObject', + 'offset' => 'setOffset', + 'limit' => 'setLimit', + 'count' => 'setCount', + 'total' => 'setTotal', + 'embedded' => 'setEmbedded' ]; @@ -134,15 +122,12 @@ public static function swaggerFormats() */ protected static $getters = [ 'links' => 'getLinks', - 'batchId' => 'getBatchId', - 'batchCreatedDate' => 'getBatchCreatedDate', - 'batchSource' => 'getBatchSource', - 'merchantReference' => 'getMerchantReference', - 'batchCaEndpoints' => 'getBatchCaEndpoints', - 'status' => 'getStatus', - 'totals' => 'getTotals', - 'billing' => 'getBilling', - 'description' => 'getDescription' + 'object' => 'getObject', + 'offset' => 'getOffset', + 'limit' => 'getLimit', + 'count' => 'getCount', + 'total' => 'getTotal', + 'embedded' => 'getEmbedded' ]; public static function attributeMap() @@ -177,15 +162,12 @@ public static function getters() public function __construct(array $data = null) { $this->container['links'] = isset($data['links']) ? $data['links'] : null; - $this->container['batchId'] = isset($data['batchId']) ? $data['batchId'] : null; - $this->container['batchCreatedDate'] = isset($data['batchCreatedDate']) ? $data['batchCreatedDate'] : null; - $this->container['batchSource'] = isset($data['batchSource']) ? $data['batchSource'] : null; - $this->container['merchantReference'] = isset($data['merchantReference']) ? $data['merchantReference'] : null; - $this->container['batchCaEndpoints'] = isset($data['batchCaEndpoints']) ? $data['batchCaEndpoints'] : null; - $this->container['status'] = isset($data['status']) ? $data['status'] : null; - $this->container['totals'] = isset($data['totals']) ? $data['totals'] : null; - $this->container['billing'] = isset($data['billing']) ? $data['billing'] : null; - $this->container['description'] = isset($data['description']) ? $data['description'] : null; + $this->container['object'] = isset($data['object']) ? $data['object'] : null; + $this->container['offset'] = isset($data['offset']) ? $data['offset'] : null; + $this->container['limit'] = isset($data['limit']) ? $data['limit'] : null; + $this->container['count'] = isset($data['count']) ? $data['count'] : null; + $this->container['total'] = isset($data['total']) ? $data['total'] : null; + $this->container['embedded'] = isset($data['embedded']) ? $data['embedded'] : null; } /** @@ -215,7 +197,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\InlineResponse20011Links + * @return \CyberSource\Model\InlineResponse20011Links[] */ public function getLinks() { @@ -224,7 +206,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\InlineResponse20011Links $links + * @param \CyberSource\Model\InlineResponse20011Links[] $links * @return $this */ public function setLinks($links) @@ -235,190 +217,127 @@ public function setLinks($links) } /** - * Gets batchId + * Gets object * @return string */ - public function getBatchId() + public function getObject() { - return $this->container['batchId']; + return $this->container['object']; } /** - * Sets batchId - * @param string $batchId Unique identification number assigned to the submitted request. + * Sets object + * @param string $object * @return $this */ - public function setBatchId($batchId) + public function setObject($object) { - $this->container['batchId'] = $batchId; + $this->container['object'] = $object; return $this; } /** - * Gets batchCreatedDate - * @return string + * Gets offset + * @return int */ - public function getBatchCreatedDate() + public function getOffset() { - return $this->container['batchCreatedDate']; + return $this->container['offset']; } /** - * Sets batchCreatedDate - * @param string $batchCreatedDate ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ + * Sets offset + * @param int $offset * @return $this */ - public function setBatchCreatedDate($batchCreatedDate) + public function setOffset($offset) { - $this->container['batchCreatedDate'] = $batchCreatedDate; + $this->container['offset'] = $offset; return $this; } /** - * Gets batchSource - * @return string + * Gets limit + * @return int */ - public function getBatchSource() + public function getLimit() { - return $this->container['batchSource']; + return $this->container['limit']; } /** - * Sets batchSource - * @param string $batchSource Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE + * Sets limit + * @param int $limit * @return $this */ - public function setBatchSource($batchSource) + public function setLimit($limit) { - $this->container['batchSource'] = $batchSource; + $this->container['limit'] = $limit; return $this; } /** - * Gets merchantReference - * @return string + * Gets count + * @return int */ - public function getMerchantReference() + public function getCount() { - return $this->container['merchantReference']; + return $this->container['count']; } /** - * Sets merchantReference - * @param string $merchantReference Reference used by merchant to identify batch. + * Sets count + * @param int $count * @return $this */ - public function setMerchantReference($merchantReference) + public function setCount($count) { - $this->container['merchantReference'] = $merchantReference; + $this->container['count'] = $count; return $this; } /** - * Gets batchCaEndpoints - * @return string + * Gets total + * @return int */ - public function getBatchCaEndpoints() + public function getTotal() { - return $this->container['batchCaEndpoints']; + return $this->container['total']; } /** - * Sets batchCaEndpoints - * @param string $batchCaEndpoints + * Sets total + * @param int $total * @return $this */ - public function setBatchCaEndpoints($batchCaEndpoints) + public function setTotal($total) { - $this->container['batchCaEndpoints'] = $batchCaEndpoints; + $this->container['total'] = $total; return $this; } /** - * Gets status - * @return string - */ - public function getStatus() - { - return $this->container['status']; - } - - /** - * Sets status - * @param string $status Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED - * @return $this - */ - public function setStatus($status) - { - $this->container['status'] = $status; - - return $this; - } - - /** - * Gets totals - * @return \CyberSource\Model\InlineResponse20010EmbeddedTotals - */ - public function getTotals() - { - return $this->container['totals']; - } - - /** - * Sets totals - * @param \CyberSource\Model\InlineResponse20010EmbeddedTotals $totals - * @return $this - */ - public function setTotals($totals) - { - $this->container['totals'] = $totals; - - return $this; - } - - /** - * Gets billing - * @return \CyberSource\Model\InlineResponse20011Billing - */ - public function getBilling() - { - return $this->container['billing']; - } - - /** - * Sets billing - * @param \CyberSource\Model\InlineResponse20011Billing $billing - * @return $this - */ - public function setBilling($billing) - { - $this->container['billing'] = $billing; - - return $this; - } - - /** - * Gets description - * @return string + * Gets embedded + * @return \CyberSource\Model\InlineResponse20011Embedded */ - public function getDescription() + public function getEmbedded() { - return $this->container['description']; + return $this->container['embedded']; } /** - * Sets description - * @param string $description + * Sets embedded + * @param \CyberSource\Model\InlineResponse20011Embedded $embedded * @return $this */ - public function setDescription($description) + public function setEmbedded($embedded) { - $this->container['description'] = $description; + $this->container['embedded'] = $embedded; return $this; } diff --git a/lib/Model/InlineResponse20010Embedded.php b/lib/Model/InlineResponse20011Embedded.php similarity index 92% rename from lib/Model/InlineResponse20010Embedded.php rename to lib/Model/InlineResponse20011Embedded.php index 20930d949..17328b19c 100644 --- a/lib/Model/InlineResponse20010Embedded.php +++ b/lib/Model/InlineResponse20011Embedded.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse20010EmbeddedBatches[]' + 'batches' => '\CyberSource\Model\InlineResponse20011EmbeddedBatches[]' ]; /** @@ -161,7 +161,7 @@ public function valid() /** * Gets batches - * @return \CyberSource\Model\InlineResponse20010EmbeddedBatches[] + * @return \CyberSource\Model\InlineResponse20011EmbeddedBatches[] */ public function getBatches() { @@ -170,7 +170,7 @@ public function getBatches() /** * Sets batches - * @param \CyberSource\Model\InlineResponse20010EmbeddedBatches[] $batches + * @param \CyberSource\Model\InlineResponse20011EmbeddedBatches[] $batches * @return $this */ public function setBatches($batches) diff --git a/lib/Model/InlineResponse20010EmbeddedBatches.php b/lib/Model/InlineResponse20011EmbeddedBatches.php similarity index 95% rename from lib/Model/InlineResponse20010EmbeddedBatches.php rename to lib/Model/InlineResponse20011EmbeddedBatches.php index 45449145c..7bbd43aa9 100644 --- a/lib/Model/InlineResponse20010EmbeddedBatches.php +++ b/lib/Model/InlineResponse20011EmbeddedBatches.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse20010EmbeddedLinks', + 'links' => '\CyberSource\Model\InlineResponse20011EmbeddedLinks', 'batchId' => 'string', 'batchCreatedDate' => 'string', 'batchModifiedDate' => 'string', @@ -62,7 +62,7 @@ class InlineResponse20010EmbeddedBatches implements ArrayAccess 'merchantReference' => 'string', 'batchCaEndpoints' => 'string[]', 'status' => 'string', - 'totals' => '\CyberSource\Model\InlineResponse20010EmbeddedTotals' + 'totals' => '\CyberSource\Model\InlineResponse20011EmbeddedTotals' ]; /** @@ -215,7 +215,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\InlineResponse20010EmbeddedLinks + * @return \CyberSource\Model\InlineResponse20011EmbeddedLinks */ public function getLinks() { @@ -224,7 +224,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\InlineResponse20010EmbeddedLinks $links + * @param \CyberSource\Model\InlineResponse20011EmbeddedLinks $links * @return $this */ public function setLinks($links) @@ -404,7 +404,7 @@ public function setStatus($status) /** * Gets totals - * @return \CyberSource\Model\InlineResponse20010EmbeddedTotals + * @return \CyberSource\Model\InlineResponse20011EmbeddedTotals */ public function getTotals() { @@ -413,7 +413,7 @@ public function getTotals() /** * Sets totals - * @param \CyberSource\Model\InlineResponse20010EmbeddedTotals $totals + * @param \CyberSource\Model\InlineResponse20011EmbeddedTotals $totals * @return $this */ public function setTotals($totals) diff --git a/lib/Model/InlineResponse20010EmbeddedLinks.php b/lib/Model/InlineResponse20011EmbeddedLinks.php similarity index 92% rename from lib/Model/InlineResponse20010EmbeddedLinks.php rename to lib/Model/InlineResponse20011EmbeddedLinks.php index c0fe75601..bdfbc59f0 100644 --- a/lib/Model/InlineResponse20010EmbeddedLinks.php +++ b/lib/Model/InlineResponse20011EmbeddedLinks.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse20010EmbeddedLinksReports[]' + 'reports' => '\CyberSource\Model\InlineResponse20011EmbeddedLinksReports[]' ]; /** @@ -161,7 +161,7 @@ public function valid() /** * Gets reports - * @return \CyberSource\Model\InlineResponse20010EmbeddedLinksReports[] + * @return \CyberSource\Model\InlineResponse20011EmbeddedLinksReports[] */ public function getReports() { @@ -170,7 +170,7 @@ public function getReports() /** * Sets reports - * @param \CyberSource\Model\InlineResponse20010EmbeddedLinksReports[] $reports + * @param \CyberSource\Model\InlineResponse20011EmbeddedLinksReports[] $reports * @return $this */ public function setReports($reports) diff --git a/lib/Model/InlineResponse20010EmbeddedLinksReports.php b/lib/Model/InlineResponse20011EmbeddedLinksReports.php similarity index 95% rename from lib/Model/InlineResponse20010EmbeddedLinksReports.php rename to lib/Model/InlineResponse20011EmbeddedLinksReports.php index 78a409aa5..a3bacba85 100644 --- a/lib/Model/InlineResponse20010EmbeddedLinksReports.php +++ b/lib/Model/InlineResponse20011EmbeddedLinksReports.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse202LinksStatus', - 'report' => '\CyberSource\Model\InlineResponse20011LinksReport[]' + 'rel' => 'string', + 'href' => 'string' ]; /** @@ -62,8 +62,8 @@ class InlineResponse20011Links implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'self' => null, - 'report' => null + 'rel' => null, + 'href' => null ]; public static function swaggerTypes() @@ -81,8 +81,8 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'self' => 'self', - 'report' => 'report' + 'rel' => 'rel', + 'href' => 'href' ]; @@ -91,8 +91,8 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'self' => 'setSelf', - 'report' => 'setReport' + 'rel' => 'setRel', + 'href' => 'setHref' ]; @@ -101,8 +101,8 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'self' => 'getSelf', - 'report' => 'getReport' + 'rel' => 'getRel', + 'href' => 'getHref' ]; public static function attributeMap() @@ -136,8 +136,8 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['self'] = isset($data['self']) ? $data['self'] : null; - $this->container['report'] = isset($data['report']) ? $data['report'] : null; + $this->container['rel'] = isset($data['rel']) ? $data['rel'] : null; + $this->container['href'] = isset($data['href']) ? $data['href'] : null; } /** @@ -166,43 +166,43 @@ public function valid() /** - * Gets self - * @return \CyberSource\Model\InlineResponse202LinksStatus + * Gets rel + * @return string */ - public function getSelf() + public function getRel() { - return $this->container['self']; + return $this->container['rel']; } /** - * Sets self - * @param \CyberSource\Model\InlineResponse202LinksStatus $self + * Sets rel + * @param string $rel Valid Values: * self * first * last * prev * next * @return $this */ - public function setSelf($self) + public function setRel($rel) { - $this->container['self'] = $self; + $this->container['rel'] = $rel; return $this; } /** - * Gets report - * @return \CyberSource\Model\InlineResponse20011LinksReport[] + * Gets href + * @return string */ - public function getReport() + public function getHref() { - return $this->container['report']; + return $this->container['href']; } /** - * Sets report - * @param \CyberSource\Model\InlineResponse20011LinksReport[] $report + * Sets href + * @param string $href * @return $this */ - public function setReport($report) + public function setHref($href) { - $this->container['report'] = $report; + $this->container['href'] = $href; return $this; } diff --git a/lib/Model/InlineResponse20012.php b/lib/Model/InlineResponse20012.php index e0aab9e4e..6620f3190 100644 --- a/lib/Model/InlineResponse20012.php +++ b/lib/Model/InlineResponse20012.php @@ -53,16 +53,16 @@ class InlineResponse20012 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'version' => 'string', - 'reportCreatedDate' => 'string', + 'links' => '\CyberSource\Model\InlineResponse20012Links', 'batchId' => 'string', - 'batchSource' => 'string', - 'batchCaEndpoints' => 'string', 'batchCreatedDate' => 'string', + 'batchSource' => 'string', 'merchantReference' => 'string', - 'totals' => '\CyberSource\Model\InlineResponse20010EmbeddedTotals', - 'billing' => '\CyberSource\Model\InlineResponse20011Billing', - 'records' => '\CyberSource\Model\InlineResponse20012Records[]' + 'batchCaEndpoints' => 'string', + 'status' => 'string', + 'totals' => '\CyberSource\Model\InlineResponse20011EmbeddedTotals', + 'billing' => '\CyberSource\Model\InlineResponse20012Billing', + 'description' => 'string' ]; /** @@ -70,16 +70,16 @@ class InlineResponse20012 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'version' => null, - 'reportCreatedDate' => null, + 'links' => null, 'batchId' => null, - 'batchSource' => null, - 'batchCaEndpoints' => null, 'batchCreatedDate' => null, + 'batchSource' => null, 'merchantReference' => null, + 'batchCaEndpoints' => null, + 'status' => null, 'totals' => null, 'billing' => null, - 'records' => null + 'description' => null ]; public static function swaggerTypes() @@ -97,16 +97,16 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'version' => 'version', - 'reportCreatedDate' => 'reportCreatedDate', + 'links' => '_links', 'batchId' => 'batchId', - 'batchSource' => 'batchSource', - 'batchCaEndpoints' => 'batchCaEndpoints', 'batchCreatedDate' => 'batchCreatedDate', + 'batchSource' => 'batchSource', 'merchantReference' => 'merchantReference', + 'batchCaEndpoints' => 'batchCaEndpoints', + 'status' => 'status', 'totals' => 'totals', 'billing' => 'billing', - 'records' => 'records' + 'description' => 'description' ]; @@ -115,16 +115,16 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'version' => 'setVersion', - 'reportCreatedDate' => 'setReportCreatedDate', + 'links' => 'setLinks', 'batchId' => 'setBatchId', - 'batchSource' => 'setBatchSource', - 'batchCaEndpoints' => 'setBatchCaEndpoints', 'batchCreatedDate' => 'setBatchCreatedDate', + 'batchSource' => 'setBatchSource', 'merchantReference' => 'setMerchantReference', + 'batchCaEndpoints' => 'setBatchCaEndpoints', + 'status' => 'setStatus', 'totals' => 'setTotals', 'billing' => 'setBilling', - 'records' => 'setRecords' + 'description' => 'setDescription' ]; @@ -133,16 +133,16 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'version' => 'getVersion', - 'reportCreatedDate' => 'getReportCreatedDate', + 'links' => 'getLinks', 'batchId' => 'getBatchId', - 'batchSource' => 'getBatchSource', - 'batchCaEndpoints' => 'getBatchCaEndpoints', 'batchCreatedDate' => 'getBatchCreatedDate', + 'batchSource' => 'getBatchSource', 'merchantReference' => 'getMerchantReference', + 'batchCaEndpoints' => 'getBatchCaEndpoints', + 'status' => 'getStatus', 'totals' => 'getTotals', 'billing' => 'getBilling', - 'records' => 'getRecords' + 'description' => 'getDescription' ]; public static function attributeMap() @@ -176,16 +176,16 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['version'] = isset($data['version']) ? $data['version'] : null; - $this->container['reportCreatedDate'] = isset($data['reportCreatedDate']) ? $data['reportCreatedDate'] : null; + $this->container['links'] = isset($data['links']) ? $data['links'] : null; $this->container['batchId'] = isset($data['batchId']) ? $data['batchId'] : null; - $this->container['batchSource'] = isset($data['batchSource']) ? $data['batchSource'] : null; - $this->container['batchCaEndpoints'] = isset($data['batchCaEndpoints']) ? $data['batchCaEndpoints'] : null; $this->container['batchCreatedDate'] = isset($data['batchCreatedDate']) ? $data['batchCreatedDate'] : null; + $this->container['batchSource'] = isset($data['batchSource']) ? $data['batchSource'] : null; $this->container['merchantReference'] = isset($data['merchantReference']) ? $data['merchantReference'] : null; + $this->container['batchCaEndpoints'] = isset($data['batchCaEndpoints']) ? $data['batchCaEndpoints'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['totals'] = isset($data['totals']) ? $data['totals'] : null; $this->container['billing'] = isset($data['billing']) ? $data['billing'] : null; - $this->container['records'] = isset($data['records']) ? $data['records'] : null; + $this->container['description'] = isset($data['description']) ? $data['description'] : null; } /** @@ -214,64 +214,64 @@ public function valid() /** - * Gets version - * @return string + * Gets links + * @return \CyberSource\Model\InlineResponse20012Links */ - public function getVersion() + public function getLinks() { - return $this->container['version']; + return $this->container['links']; } /** - * Sets version - * @param string $version + * Sets links + * @param \CyberSource\Model\InlineResponse20012Links $links * @return $this */ - public function setVersion($version) + public function setLinks($links) { - $this->container['version'] = $version; + $this->container['links'] = $links; return $this; } /** - * Gets reportCreatedDate + * Gets batchId * @return string */ - public function getReportCreatedDate() + public function getBatchId() { - return $this->container['reportCreatedDate']; + return $this->container['batchId']; } /** - * Sets reportCreatedDate - * @param string $reportCreatedDate ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ + * Sets batchId + * @param string $batchId Unique identification number assigned to the submitted request. * @return $this */ - public function setReportCreatedDate($reportCreatedDate) + public function setBatchId($batchId) { - $this->container['reportCreatedDate'] = $reportCreatedDate; + $this->container['batchId'] = $batchId; return $this; } /** - * Gets batchId + * Gets batchCreatedDate * @return string */ - public function getBatchId() + public function getBatchCreatedDate() { - return $this->container['batchId']; + return $this->container['batchCreatedDate']; } /** - * Sets batchId - * @param string $batchId Unique identification number assigned to the submitted request. + * Sets batchCreatedDate + * @param string $batchCreatedDate ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ * @return $this */ - public function setBatchId($batchId) + public function setBatchCreatedDate($batchCreatedDate) { - $this->container['batchId'] = $batchId; + $this->container['batchCreatedDate'] = $batchCreatedDate; return $this; } @@ -298,71 +298,71 @@ public function setBatchSource($batchSource) } /** - * Gets batchCaEndpoints + * Gets merchantReference * @return string */ - public function getBatchCaEndpoints() + public function getMerchantReference() { - return $this->container['batchCaEndpoints']; + return $this->container['merchantReference']; } /** - * Sets batchCaEndpoints - * @param string $batchCaEndpoints + * Sets merchantReference + * @param string $merchantReference Reference used by merchant to identify batch. * @return $this */ - public function setBatchCaEndpoints($batchCaEndpoints) + public function setMerchantReference($merchantReference) { - $this->container['batchCaEndpoints'] = $batchCaEndpoints; + $this->container['merchantReference'] = $merchantReference; return $this; } /** - * Gets batchCreatedDate + * Gets batchCaEndpoints * @return string */ - public function getBatchCreatedDate() + public function getBatchCaEndpoints() { - return $this->container['batchCreatedDate']; + return $this->container['batchCaEndpoints']; } /** - * Sets batchCreatedDate - * @param string $batchCreatedDate ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ + * Sets batchCaEndpoints + * @param string $batchCaEndpoints * @return $this */ - public function setBatchCreatedDate($batchCreatedDate) + public function setBatchCaEndpoints($batchCaEndpoints) { - $this->container['batchCreatedDate'] = $batchCreatedDate; + $this->container['batchCaEndpoints'] = $batchCaEndpoints; return $this; } /** - * Gets merchantReference + * Gets status * @return string */ - public function getMerchantReference() + public function getStatus() { - return $this->container['merchantReference']; + return $this->container['status']; } /** - * Sets merchantReference - * @param string $merchantReference Reference used by merchant to identify batch. + * Sets status + * @param string $status Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED * @return $this */ - public function setMerchantReference($merchantReference) + public function setStatus($status) { - $this->container['merchantReference'] = $merchantReference; + $this->container['status'] = $status; return $this; } /** * Gets totals - * @return \CyberSource\Model\InlineResponse20010EmbeddedTotals + * @return \CyberSource\Model\InlineResponse20011EmbeddedTotals */ public function getTotals() { @@ -371,7 +371,7 @@ public function getTotals() /** * Sets totals - * @param \CyberSource\Model\InlineResponse20010EmbeddedTotals $totals + * @param \CyberSource\Model\InlineResponse20011EmbeddedTotals $totals * @return $this */ public function setTotals($totals) @@ -383,7 +383,7 @@ public function setTotals($totals) /** * Gets billing - * @return \CyberSource\Model\InlineResponse20011Billing + * @return \CyberSource\Model\InlineResponse20012Billing */ public function getBilling() { @@ -392,7 +392,7 @@ public function getBilling() /** * Sets billing - * @param \CyberSource\Model\InlineResponse20011Billing $billing + * @param \CyberSource\Model\InlineResponse20012Billing $billing * @return $this */ public function setBilling($billing) @@ -403,22 +403,22 @@ public function setBilling($billing) } /** - * Gets records - * @return \CyberSource\Model\InlineResponse20012Records[] + * Gets description + * @return string */ - public function getRecords() + public function getDescription() { - return $this->container['records']; + return $this->container['description']; } /** - * Sets records - * @param \CyberSource\Model\InlineResponse20012Records[] $records + * Sets description + * @param string $description * @return $this */ - public function setRecords($records) + public function setDescription($description) { - $this->container['records'] = $records; + $this->container['description'] = $description; return $this; } diff --git a/lib/Model/InlineResponse20011Billing.php b/lib/Model/InlineResponse20012Billing.php similarity index 97% rename from lib/Model/InlineResponse20011Billing.php rename to lib/Model/InlineResponse20012Billing.php index a65e57f94..ebb839660 100644 --- a/lib/Model/InlineResponse20011Billing.php +++ b/lib/Model/InlineResponse20012Billing.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse202LinksStatus', + 'report' => '\CyberSource\Model\InlineResponse20012LinksReport[]' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'self' => null, + 'report' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'self' => 'self', + 'report' => 'report' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'self' => 'setSelf', + 'report' => 'setReport' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'self' => 'getSelf', + 'report' => 'getReport' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['self'] = isset($data['self']) ? $data['self'] : null; + $this->container['report'] = isset($data['report']) ? $data['report'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets self + * @return \CyberSource\Model\InlineResponse202LinksStatus + */ + public function getSelf() + { + return $this->container['self']; + } + + /** + * Sets self + * @param \CyberSource\Model\InlineResponse202LinksStatus $self + * @return $this + */ + public function setSelf($self) + { + $this->container['self'] = $self; + + return $this; + } + + /** + * Gets report + * @return \CyberSource\Model\InlineResponse20012LinksReport[] + */ + public function getReport() + { + return $this->container['report']; + } + + /** + * Sets report + * @param \CyberSource\Model\InlineResponse20012LinksReport[] $report + * @return $this + */ + public function setReport($report) + { + $this->container['report'] = $report; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/InlineResponse20011LinksReport.php b/lib/Model/InlineResponse20012LinksReport.php similarity index 96% rename from lib/Model/InlineResponse20011LinksReport.php rename to lib/Model/InlineResponse20012LinksReport.php index e7e15028f..6b7885ceb 100644 --- a/lib/Model/InlineResponse20011LinksReport.php +++ b/lib/Model/InlineResponse20012LinksReport.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation', - 'requestId' => 'string', - 'submitTimeUtc' => 'string', - 'bankAccountValidation' => '\CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation' + 'version' => 'string', + 'reportCreatedDate' => 'string', + 'batchId' => 'string', + 'batchSource' => 'string', + 'batchCaEndpoints' => 'string', + 'batchCreatedDate' => 'string', + 'merchantReference' => 'string', + 'totals' => '\CyberSource\Model\InlineResponse20011EmbeddedTotals', + 'billing' => '\CyberSource\Model\InlineResponse20012Billing', + 'records' => '\CyberSource\Model\InlineResponse20013Records[]' ]; /** @@ -64,10 +70,16 @@ class InlineResponse20013 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'clientReferenceInformation' => null, - 'requestId' => null, - 'submitTimeUtc' => null, - 'bankAccountValidation' => null + 'version' => null, + 'reportCreatedDate' => null, + 'batchId' => null, + 'batchSource' => null, + 'batchCaEndpoints' => null, + 'batchCreatedDate' => null, + 'merchantReference' => null, + 'totals' => null, + 'billing' => null, + 'records' => null ]; public static function swaggerTypes() @@ -85,10 +97,16 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'clientReferenceInformation' => 'clientReferenceInformation', - 'requestId' => 'requestId', - 'submitTimeUtc' => 'submitTimeUtc', - 'bankAccountValidation' => 'bankAccountValidation' + 'version' => 'version', + 'reportCreatedDate' => 'reportCreatedDate', + 'batchId' => 'batchId', + 'batchSource' => 'batchSource', + 'batchCaEndpoints' => 'batchCaEndpoints', + 'batchCreatedDate' => 'batchCreatedDate', + 'merchantReference' => 'merchantReference', + 'totals' => 'totals', + 'billing' => 'billing', + 'records' => 'records' ]; @@ -97,10 +115,16 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'clientReferenceInformation' => 'setClientReferenceInformation', - 'requestId' => 'setRequestId', - 'submitTimeUtc' => 'setSubmitTimeUtc', - 'bankAccountValidation' => 'setBankAccountValidation' + 'version' => 'setVersion', + 'reportCreatedDate' => 'setReportCreatedDate', + 'batchId' => 'setBatchId', + 'batchSource' => 'setBatchSource', + 'batchCaEndpoints' => 'setBatchCaEndpoints', + 'batchCreatedDate' => 'setBatchCreatedDate', + 'merchantReference' => 'setMerchantReference', + 'totals' => 'setTotals', + 'billing' => 'setBilling', + 'records' => 'setRecords' ]; @@ -109,10 +133,16 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'clientReferenceInformation' => 'getClientReferenceInformation', - 'requestId' => 'getRequestId', - 'submitTimeUtc' => 'getSubmitTimeUtc', - 'bankAccountValidation' => 'getBankAccountValidation' + 'version' => 'getVersion', + 'reportCreatedDate' => 'getReportCreatedDate', + 'batchId' => 'getBatchId', + 'batchSource' => 'getBatchSource', + 'batchCaEndpoints' => 'getBatchCaEndpoints', + 'batchCreatedDate' => 'getBatchCreatedDate', + 'merchantReference' => 'getMerchantReference', + 'totals' => 'getTotals', + 'billing' => 'getBilling', + 'records' => 'getRecords' ]; public static function attributeMap() @@ -146,10 +176,16 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; - $this->container['requestId'] = isset($data['requestId']) ? $data['requestId'] : null; - $this->container['submitTimeUtc'] = isset($data['submitTimeUtc']) ? $data['submitTimeUtc'] : null; - $this->container['bankAccountValidation'] = isset($data['bankAccountValidation']) ? $data['bankAccountValidation'] : null; + $this->container['version'] = isset($data['version']) ? $data['version'] : null; + $this->container['reportCreatedDate'] = isset($data['reportCreatedDate']) ? $data['reportCreatedDate'] : null; + $this->container['batchId'] = isset($data['batchId']) ? $data['batchId'] : null; + $this->container['batchSource'] = isset($data['batchSource']) ? $data['batchSource'] : null; + $this->container['batchCaEndpoints'] = isset($data['batchCaEndpoints']) ? $data['batchCaEndpoints'] : null; + $this->container['batchCreatedDate'] = isset($data['batchCreatedDate']) ? $data['batchCreatedDate'] : null; + $this->container['merchantReference'] = isset($data['merchantReference']) ? $data['merchantReference'] : null; + $this->container['totals'] = isset($data['totals']) ? $data['totals'] : null; + $this->container['billing'] = isset($data['billing']) ? $data['billing'] : null; + $this->container['records'] = isset($data['records']) ? $data['records'] : null; } /** @@ -178,85 +214,211 @@ public function valid() /** - * Gets clientReferenceInformation - * @return \CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation + * Gets version + * @return string + */ + public function getVersion() + { + return $this->container['version']; + } + + /** + * Sets version + * @param string $version + * @return $this + */ + public function setVersion($version) + { + $this->container['version'] = $version; + + return $this; + } + + /** + * Gets reportCreatedDate + * @return string + */ + public function getReportCreatedDate() + { + return $this->container['reportCreatedDate']; + } + + /** + * Sets reportCreatedDate + * @param string $reportCreatedDate ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ + * @return $this */ - public function getClientReferenceInformation() + public function setReportCreatedDate($reportCreatedDate) { - return $this->container['clientReferenceInformation']; + $this->container['reportCreatedDate'] = $reportCreatedDate; + + return $this; } /** - * Sets clientReferenceInformation - * @param \CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation $clientReferenceInformation + * Gets batchId + * @return string + */ + public function getBatchId() + { + return $this->container['batchId']; + } + + /** + * Sets batchId + * @param string $batchId Unique identification number assigned to the submitted request. * @return $this */ - public function setClientReferenceInformation($clientReferenceInformation) + public function setBatchId($batchId) { - $this->container['clientReferenceInformation'] = $clientReferenceInformation; + $this->container['batchId'] = $batchId; return $this; } /** - * Gets requestId + * Gets batchSource * @return string */ - public function getRequestId() + public function getBatchSource() { - return $this->container['requestId']; + return $this->container['batchSource']; } /** - * Sets requestId - * @param string $requestId Request Id sent as part of the request. + * Sets batchSource + * @param string $batchSource Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE * @return $this */ - public function setRequestId($requestId) + public function setBatchSource($batchSource) { - $this->container['requestId'] = $requestId; + $this->container['batchSource'] = $batchSource; return $this; } /** - * Gets submitTimeUtc + * Gets batchCaEndpoints * @return string */ - public function getSubmitTimeUtc() + public function getBatchCaEndpoints() + { + return $this->container['batchCaEndpoints']; + } + + /** + * Sets batchCaEndpoints + * @param string $batchCaEndpoints + * @return $this + */ + public function setBatchCaEndpoints($batchCaEndpoints) + { + $this->container['batchCaEndpoints'] = $batchCaEndpoints; + + return $this; + } + + /** + * Gets batchCreatedDate + * @return string + */ + public function getBatchCreatedDate() + { + return $this->container['batchCreatedDate']; + } + + /** + * Sets batchCreatedDate + * @param string $batchCreatedDate ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ + * @return $this + */ + public function setBatchCreatedDate($batchCreatedDate) + { + $this->container['batchCreatedDate'] = $batchCreatedDate; + + return $this; + } + + /** + * Gets merchantReference + * @return string + */ + public function getMerchantReference() + { + return $this->container['merchantReference']; + } + + /** + * Sets merchantReference + * @param string $merchantReference Reference used by merchant to identify batch. + * @return $this + */ + public function setMerchantReference($merchantReference) + { + $this->container['merchantReference'] = $merchantReference; + + return $this; + } + + /** + * Gets totals + * @return \CyberSource\Model\InlineResponse20011EmbeddedTotals + */ + public function getTotals() + { + return $this->container['totals']; + } + + /** + * Sets totals + * @param \CyberSource\Model\InlineResponse20011EmbeddedTotals $totals + * @return $this + */ + public function setTotals($totals) + { + $this->container['totals'] = $totals; + + return $this; + } + + /** + * Gets billing + * @return \CyberSource\Model\InlineResponse20012Billing + */ + public function getBilling() { - return $this->container['submitTimeUtc']; + return $this->container['billing']; } /** - * Sets submitTimeUtc - * @param string $submitTimeUtc Time of request in UTC. Format: `YYYY-MM-DDThhmmssZ`, where: - `T`: Separates the date and the time - `Z`: Indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT) Example: `2020-01-11T224757Z` equals January 11, 2020, at 22:47:57 (10:47:57 p.m.) + * Sets billing + * @param \CyberSource\Model\InlineResponse20012Billing $billing * @return $this */ - public function setSubmitTimeUtc($submitTimeUtc) + public function setBilling($billing) { - $this->container['submitTimeUtc'] = $submitTimeUtc; + $this->container['billing'] = $billing; return $this; } /** - * Gets bankAccountValidation - * @return \CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation + * Gets records + * @return \CyberSource\Model\InlineResponse20013Records[] */ - public function getBankAccountValidation() + public function getRecords() { - return $this->container['bankAccountValidation']; + return $this->container['records']; } /** - * Sets bankAccountValidation - * @param \CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation $bankAccountValidation + * Sets records + * @param \CyberSource\Model\InlineResponse20013Records[] $records * @return $this */ - public function setBankAccountValidation($bankAccountValidation) + public function setRecords($records) { - $this->container['bankAccountValidation'] = $bankAccountValidation; + $this->container['records'] = $records; return $this; } diff --git a/lib/Model/InlineResponse20012Records.php b/lib/Model/InlineResponse20013Records.php similarity index 93% rename from lib/Model/InlineResponse20012Records.php rename to lib/Model/InlineResponse20013Records.php index 101882590..13e2ff5bb 100644 --- a/lib/Model/InlineResponse20012Records.php +++ b/lib/Model/InlineResponse20013Records.php @@ -1,6 +1,6 @@ 'string', - 'sourceRecord' => '\CyberSource\Model\InlineResponse20012SourceRecord', - 'responseRecord' => '\CyberSource\Model\InlineResponse20012ResponseRecord' + 'sourceRecord' => '\CyberSource\Model\InlineResponse20013SourceRecord', + 'responseRecord' => '\CyberSource\Model\InlineResponse20013ResponseRecord' ]; /** @@ -194,7 +194,7 @@ public function setId($id) /** * Gets sourceRecord - * @return \CyberSource\Model\InlineResponse20012SourceRecord + * @return \CyberSource\Model\InlineResponse20013SourceRecord */ public function getSourceRecord() { @@ -203,7 +203,7 @@ public function getSourceRecord() /** * Sets sourceRecord - * @param \CyberSource\Model\InlineResponse20012SourceRecord $sourceRecord + * @param \CyberSource\Model\InlineResponse20013SourceRecord $sourceRecord * @return $this */ public function setSourceRecord($sourceRecord) @@ -215,7 +215,7 @@ public function setSourceRecord($sourceRecord) /** * Gets responseRecord - * @return \CyberSource\Model\InlineResponse20012ResponseRecord + * @return \CyberSource\Model\InlineResponse20013ResponseRecord */ public function getResponseRecord() { @@ -224,7 +224,7 @@ public function getResponseRecord() /** * Sets responseRecord - * @param \CyberSource\Model\InlineResponse20012ResponseRecord $responseRecord + * @param \CyberSource\Model\InlineResponse20013ResponseRecord $responseRecord * @return $this */ public function setResponseRecord($responseRecord) diff --git a/lib/Model/InlineResponse20012ResponseRecord.php b/lib/Model/InlineResponse20013ResponseRecord.php similarity index 96% rename from lib/Model/InlineResponse20012ResponseRecord.php rename to lib/Model/InlineResponse20013ResponseRecord.php index 7397f16bb..b875d7f41 100644 --- a/lib/Model/InlineResponse20012ResponseRecord.php +++ b/lib/Model/InlineResponse20013ResponseRecord.php @@ -1,6 +1,6 @@ 'string', 'cardExpiryYear' => 'string', 'cardType' => 'string', - 'additionalUpdates' => '\CyberSource\Model\InlineResponse20012ResponseRecordAdditionalUpdates[]' + 'additionalUpdates' => '\CyberSource\Model\InlineResponse20013ResponseRecordAdditionalUpdates[]' ]; /** @@ -404,7 +404,7 @@ public function setCardType($cardType) /** * Gets additionalUpdates - * @return \CyberSource\Model\InlineResponse20012ResponseRecordAdditionalUpdates[] + * @return \CyberSource\Model\InlineResponse20013ResponseRecordAdditionalUpdates[] */ public function getAdditionalUpdates() { @@ -413,7 +413,7 @@ public function getAdditionalUpdates() /** * Sets additionalUpdates - * @param \CyberSource\Model\InlineResponse20012ResponseRecordAdditionalUpdates[] $additionalUpdates + * @param \CyberSource\Model\InlineResponse20013ResponseRecordAdditionalUpdates[] $additionalUpdates * @return $this */ public function setAdditionalUpdates($additionalUpdates) diff --git a/lib/Model/InlineResponse20012ResponseRecordAdditionalUpdates.php b/lib/Model/InlineResponse20013ResponseRecordAdditionalUpdates.php similarity index 97% rename from lib/Model/InlineResponse20012ResponseRecordAdditionalUpdates.php rename to lib/Model/InlineResponse20013ResponseRecordAdditionalUpdates.php index 13aca0074..8ed997366 100644 --- a/lib/Model/InlineResponse20012ResponseRecordAdditionalUpdates.php +++ b/lib/Model/InlineResponse20013ResponseRecordAdditionalUpdates.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse20014ClientReferenceInformation', - 'id' => 'string', + 'clientReferenceInformation' => '\CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation', + 'requestId' => 'string', 'submitTimeUtc' => 'string', - 'status' => 'string', - 'errorInformation' => '\CyberSource\Model\InlineResponse2018ErrorInformation', - 'orderInformation' => '\CyberSource\Model\InlineResponse2018OrderInformation' + 'bankAccountValidation' => '\CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation' ]; /** @@ -67,11 +65,9 @@ class InlineResponse20014 implements ArrayAccess */ protected static $swaggerFormats = [ 'clientReferenceInformation' => null, - 'id' => null, + 'requestId' => null, 'submitTimeUtc' => null, - 'status' => null, - 'errorInformation' => null, - 'orderInformation' => null + 'bankAccountValidation' => null ]; public static function swaggerTypes() @@ -90,11 +86,9 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'clientReferenceInformation' => 'clientReferenceInformation', - 'id' => 'id', + 'requestId' => 'requestId', 'submitTimeUtc' => 'submitTimeUtc', - 'status' => 'status', - 'errorInformation' => 'errorInformation', - 'orderInformation' => 'orderInformation' + 'bankAccountValidation' => 'bankAccountValidation' ]; @@ -104,11 +98,9 @@ public static function swaggerFormats() */ protected static $setters = [ 'clientReferenceInformation' => 'setClientReferenceInformation', - 'id' => 'setId', + 'requestId' => 'setRequestId', 'submitTimeUtc' => 'setSubmitTimeUtc', - 'status' => 'setStatus', - 'errorInformation' => 'setErrorInformation', - 'orderInformation' => 'setOrderInformation' + 'bankAccountValidation' => 'setBankAccountValidation' ]; @@ -118,11 +110,9 @@ public static function swaggerFormats() */ protected static $getters = [ 'clientReferenceInformation' => 'getClientReferenceInformation', - 'id' => 'getId', + 'requestId' => 'getRequestId', 'submitTimeUtc' => 'getSubmitTimeUtc', - 'status' => 'getStatus', - 'errorInformation' => 'getErrorInformation', - 'orderInformation' => 'getOrderInformation' + 'bankAccountValidation' => 'getBankAccountValidation' ]; public static function attributeMap() @@ -157,11 +147,9 @@ public static function getters() public function __construct(array $data = null) { $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; - $this->container['id'] = isset($data['id']) ? $data['id'] : null; + $this->container['requestId'] = isset($data['requestId']) ? $data['requestId'] : null; $this->container['submitTimeUtc'] = isset($data['submitTimeUtc']) ? $data['submitTimeUtc'] : null; - $this->container['status'] = isset($data['status']) ? $data['status'] : null; - $this->container['errorInformation'] = isset($data['errorInformation']) ? $data['errorInformation'] : null; - $this->container['orderInformation'] = isset($data['orderInformation']) ? $data['orderInformation'] : null; + $this->container['bankAccountValidation'] = isset($data['bankAccountValidation']) ? $data['bankAccountValidation'] : null; } /** @@ -173,15 +161,6 @@ public function listInvalidProperties() { $invalid_properties = []; - if ($this->container['id'] === null) { - $invalid_properties[] = "'id' can't be null"; - } - if ($this->container['submitTimeUtc'] === null) { - $invalid_properties[] = "'submitTimeUtc' can't be null"; - } - if ($this->container['status'] === null) { - $invalid_properties[] = "'status' can't be null"; - } return $invalid_properties; } @@ -194,22 +173,13 @@ public function listInvalidProperties() public function valid() { - if ($this->container['id'] === null) { - return false; - } - if ($this->container['submitTimeUtc'] === null) { - return false; - } - if ($this->container['status'] === null) { - return false; - } return true; } /** * Gets clientReferenceInformation - * @return \CyberSource\Model\InlineResponse20014ClientReferenceInformation + * @return \CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation */ public function getClientReferenceInformation() { @@ -218,7 +188,7 @@ public function getClientReferenceInformation() /** * Sets clientReferenceInformation - * @param \CyberSource\Model\InlineResponse20014ClientReferenceInformation $clientReferenceInformation + * @param \CyberSource\Model\Bavsv1accountvalidationsClientReferenceInformation $clientReferenceInformation * @return $this */ public function setClientReferenceInformation($clientReferenceInformation) @@ -229,22 +199,22 @@ public function setClientReferenceInformation($clientReferenceInformation) } /** - * Gets id + * Gets requestId * @return string */ - public function getId() + public function getRequestId() { - return $this->container['id']; + return $this->container['requestId']; } /** - * Sets id - * @param string $id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid + * Sets requestId + * @param string $requestId Request Id sent as part of the request. * @return $this */ - public function setId($id) + public function setRequestId($requestId) { - $this->container['id'] = $id; + $this->container['requestId'] = $requestId; return $this; } @@ -260,7 +230,7 @@ public function getSubmitTimeUtc() /** * Sets submitTimeUtc - * @param string $submitTimeUtc Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @param string $submitTimeUtc Time of request in UTC. Format: `YYYY-MM-DDThhmmssZ`, where: - `T`: Separates the date and the time - `Z`: Indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT) Example: `2020-01-11T224757Z` equals January 11, 2020, at 22:47:57 (10:47:57 p.m.) * @return $this */ public function setSubmitTimeUtc($submitTimeUtc) @@ -271,64 +241,22 @@ public function setSubmitTimeUtc($submitTimeUtc) } /** - * Gets status - * @return string - */ - public function getStatus() - { - return $this->container['status']; - } - - /** - * Sets status - * @param string $status Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` - * @return $this - */ - public function setStatus($status) - { - $this->container['status'] = $status; - - return $this; - } - - /** - * Gets errorInformation - * @return \CyberSource\Model\InlineResponse2018ErrorInformation - */ - public function getErrorInformation() - { - return $this->container['errorInformation']; - } - - /** - * Sets errorInformation - * @param \CyberSource\Model\InlineResponse2018ErrorInformation $errorInformation - * @return $this - */ - public function setErrorInformation($errorInformation) - { - $this->container['errorInformation'] = $errorInformation; - - return $this; - } - - /** - * Gets orderInformation - * @return \CyberSource\Model\InlineResponse2018OrderInformation + * Gets bankAccountValidation + * @return \CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation */ - public function getOrderInformation() + public function getBankAccountValidation() { - return $this->container['orderInformation']; + return $this->container['bankAccountValidation']; } /** - * Sets orderInformation - * @param \CyberSource\Model\InlineResponse2018OrderInformation $orderInformation + * Sets bankAccountValidation + * @param \CyberSource\Model\TssV2TransactionsGet200ResponseBankAccountValidation $bankAccountValidation * @return $this */ - public function setOrderInformation($orderInformation) + public function setBankAccountValidation($bankAccountValidation) { - $this->container['orderInformation'] = $orderInformation; + $this->container['bankAccountValidation'] = $bankAccountValidation; return $this; } diff --git a/lib/Model/InlineResponse20015.php b/lib/Model/InlineResponse20015.php new file mode 100644 index 000000000..3f94541a5 --- /dev/null +++ b/lib/Model/InlineResponse20015.php @@ -0,0 +1,398 @@ + '\CyberSource\Model\InlineResponse20015ClientReferenceInformation', + 'id' => 'string', + 'submitTimeUtc' => 'string', + 'status' => 'string', + 'errorInformation' => '\CyberSource\Model\InlineResponse2018ErrorInformation', + 'orderInformation' => '\CyberSource\Model\InlineResponse2018OrderInformation' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'clientReferenceInformation' => null, + 'id' => null, + 'submitTimeUtc' => null, + 'status' => null, + 'errorInformation' => null, + 'orderInformation' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'clientReferenceInformation' => 'clientReferenceInformation', + 'id' => 'id', + 'submitTimeUtc' => 'submitTimeUtc', + 'status' => 'status', + 'errorInformation' => 'errorInformation', + 'orderInformation' => 'orderInformation' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'clientReferenceInformation' => 'setClientReferenceInformation', + 'id' => 'setId', + 'submitTimeUtc' => 'setSubmitTimeUtc', + 'status' => 'setStatus', + 'errorInformation' => 'setErrorInformation', + 'orderInformation' => 'setOrderInformation' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'clientReferenceInformation' => 'getClientReferenceInformation', + 'id' => 'getId', + 'submitTimeUtc' => 'getSubmitTimeUtc', + 'status' => 'getStatus', + 'errorInformation' => 'getErrorInformation', + 'orderInformation' => 'getOrderInformation' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; + $this->container['id'] = isset($data['id']) ? $data['id'] : null; + $this->container['submitTimeUtc'] = isset($data['submitTimeUtc']) ? $data['submitTimeUtc'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['errorInformation'] = isset($data['errorInformation']) ? $data['errorInformation'] : null; + $this->container['orderInformation'] = isset($data['orderInformation']) ? $data['orderInformation'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + if ($this->container['id'] === null) { + $invalid_properties[] = "'id' can't be null"; + } + if ($this->container['submitTimeUtc'] === null) { + $invalid_properties[] = "'submitTimeUtc' can't be null"; + } + if ($this->container['status'] === null) { + $invalid_properties[] = "'status' can't be null"; + } + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + if ($this->container['id'] === null) { + return false; + } + if ($this->container['submitTimeUtc'] === null) { + return false; + } + if ($this->container['status'] === null) { + return false; + } + return true; + } + + + /** + * Gets clientReferenceInformation + * @return \CyberSource\Model\InlineResponse20015ClientReferenceInformation + */ + public function getClientReferenceInformation() + { + return $this->container['clientReferenceInformation']; + } + + /** + * Sets clientReferenceInformation + * @param \CyberSource\Model\InlineResponse20015ClientReferenceInformation $clientReferenceInformation + * @return $this + */ + public function setClientReferenceInformation($clientReferenceInformation) + { + $this->container['clientReferenceInformation'] = $clientReferenceInformation; + + return $this; + } + + /** + * Gets id + * @return string + */ + public function getId() + { + return $this->container['id']; + } + + /** + * Sets id + * @param string $id Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid + * @return $this + */ + public function setId($id) + { + $this->container['id'] = $id; + + return $this; + } + + /** + * Gets submitTimeUtc + * @return string + */ + public function getSubmitTimeUtc() + { + return $this->container['submitTimeUtc']; + } + + /** + * Sets submitTimeUtc + * @param string $submitTimeUtc Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. + * @return $this + */ + public function setSubmitTimeUtc($submitTimeUtc) + { + $this->container['submitTimeUtc'] = $submitTimeUtc; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` + * @return $this + */ + public function setStatus($status) + { + $this->container['status'] = $status; + + return $this; + } + + /** + * Gets errorInformation + * @return \CyberSource\Model\InlineResponse2018ErrorInformation + */ + public function getErrorInformation() + { + return $this->container['errorInformation']; + } + + /** + * Sets errorInformation + * @param \CyberSource\Model\InlineResponse2018ErrorInformation $errorInformation + * @return $this + */ + public function setErrorInformation($errorInformation) + { + $this->container['errorInformation'] = $errorInformation; + + return $this; + } + + /** + * Gets orderInformation + * @return \CyberSource\Model\InlineResponse2018OrderInformation + */ + public function getOrderInformation() + { + return $this->container['orderInformation']; + } + + /** + * Sets orderInformation + * @param \CyberSource\Model\InlineResponse2018OrderInformation $orderInformation + * @return $this + */ + public function setOrderInformation($orderInformation) + { + $this->container['orderInformation'] = $orderInformation; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/InlineResponse20014ClientReferenceInformation.php b/lib/Model/InlineResponse20015ClientReferenceInformation.php similarity index 97% rename from lib/Model/InlineResponse20014ClientReferenceInformation.php rename to lib/Model/InlineResponse20015ClientReferenceInformation.php index fa0ebbde3..61a636672 100644 --- a/lib/Model/InlineResponse20014ClientReferenceInformation.php +++ b/lib/Model/InlineResponse20015ClientReferenceInformation.php @@ -1,6 +1,6 @@ 'int', - 'fieldType' => 'string', - 'label' => 'string', - 'customerVisible' => 'bool', - 'textMinLength' => 'int', - 'textMaxLength' => 'int', - 'possibleValues' => 'string', - 'textDefaultValue' => 'string', - 'merchantId' => 'string', - 'referenceType' => 'string', - 'readOnly' => 'bool', - 'merchantDefinedDataIndex' => 'int' + 'id' => 'string', + 'submitTimeUtc' => 'string', + 'status' => 'string', + 'embedded' => '\CyberSource\Model\InlineResponse2002Embedded' ]; /** @@ -72,18 +64,10 @@ class InlineResponse2002 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'id' => 'int64', - 'fieldType' => null, - 'label' => null, - 'customerVisible' => null, - 'textMinLength' => 'int32', - 'textMaxLength' => 'int32', - 'possibleValues' => null, - 'textDefaultValue' => null, - 'merchantId' => null, - 'referenceType' => null, - 'readOnly' => null, - 'merchantDefinedDataIndex' => 'int32' + 'id' => null, + 'submitTimeUtc' => null, + 'status' => null, + 'embedded' => null ]; public static function swaggerTypes() @@ -102,17 +86,9 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'id' => 'id', - 'fieldType' => 'fieldType', - 'label' => 'label', - 'customerVisible' => 'customerVisible', - 'textMinLength' => 'textMinLength', - 'textMaxLength' => 'textMaxLength', - 'possibleValues' => 'possibleValues', - 'textDefaultValue' => 'textDefaultValue', - 'merchantId' => 'merchantId', - 'referenceType' => 'referenceType', - 'readOnly' => 'readOnly', - 'merchantDefinedDataIndex' => 'merchantDefinedDataIndex' + 'submitTimeUtc' => 'submitTimeUtc', + 'status' => 'status', + 'embedded' => '_embedded' ]; @@ -122,17 +98,9 @@ public static function swaggerFormats() */ protected static $setters = [ 'id' => 'setId', - 'fieldType' => 'setFieldType', - 'label' => 'setLabel', - 'customerVisible' => 'setCustomerVisible', - 'textMinLength' => 'setTextMinLength', - 'textMaxLength' => 'setTextMaxLength', - 'possibleValues' => 'setPossibleValues', - 'textDefaultValue' => 'setTextDefaultValue', - 'merchantId' => 'setMerchantId', - 'referenceType' => 'setReferenceType', - 'readOnly' => 'setReadOnly', - 'merchantDefinedDataIndex' => 'setMerchantDefinedDataIndex' + 'submitTimeUtc' => 'setSubmitTimeUtc', + 'status' => 'setStatus', + 'embedded' => 'setEmbedded' ]; @@ -142,17 +110,9 @@ public static function swaggerFormats() */ protected static $getters = [ 'id' => 'getId', - 'fieldType' => 'getFieldType', - 'label' => 'getLabel', - 'customerVisible' => 'getCustomerVisible', - 'textMinLength' => 'getTextMinLength', - 'textMaxLength' => 'getTextMaxLength', - 'possibleValues' => 'getPossibleValues', - 'textDefaultValue' => 'getTextDefaultValue', - 'merchantId' => 'getMerchantId', - 'referenceType' => 'getReferenceType', - 'readOnly' => 'getReadOnly', - 'merchantDefinedDataIndex' => 'getMerchantDefinedDataIndex' + 'submitTimeUtc' => 'getSubmitTimeUtc', + 'status' => 'getStatus', + 'embedded' => 'getEmbedded' ]; public static function attributeMap() @@ -187,17 +147,9 @@ public static function getters() public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; - $this->container['fieldType'] = isset($data['fieldType']) ? $data['fieldType'] : null; - $this->container['label'] = isset($data['label']) ? $data['label'] : null; - $this->container['customerVisible'] = isset($data['customerVisible']) ? $data['customerVisible'] : null; - $this->container['textMinLength'] = isset($data['textMinLength']) ? $data['textMinLength'] : null; - $this->container['textMaxLength'] = isset($data['textMaxLength']) ? $data['textMaxLength'] : null; - $this->container['possibleValues'] = isset($data['possibleValues']) ? $data['possibleValues'] : null; - $this->container['textDefaultValue'] = isset($data['textDefaultValue']) ? $data['textDefaultValue'] : null; - $this->container['merchantId'] = isset($data['merchantId']) ? $data['merchantId'] : null; - $this->container['referenceType'] = isset($data['referenceType']) ? $data['referenceType'] : null; - $this->container['readOnly'] = isset($data['readOnly']) ? $data['readOnly'] : null; - $this->container['merchantDefinedDataIndex'] = isset($data['merchantDefinedDataIndex']) ? $data['merchantDefinedDataIndex'] : null; + $this->container['submitTimeUtc'] = isset($data['submitTimeUtc']) ? $data['submitTimeUtc'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['embedded'] = isset($data['embedded']) ? $data['embedded'] : null; } /** @@ -227,7 +179,7 @@ public function valid() /** * Gets id - * @return int + * @return string */ public function getId() { @@ -236,7 +188,7 @@ public function getId() /** * Sets id - * @param int $id + * @param string $id UUID uniquely generated for this comments. * @return $this */ public function setId($id) @@ -247,232 +199,64 @@ public function setId($id) } /** - * Gets fieldType + * Gets submitTimeUtc * @return string */ - public function getFieldType() + public function getSubmitTimeUtc() { - return $this->container['fieldType']; + return $this->container['submitTimeUtc']; } /** - * Sets fieldType - * @param string $fieldType + * Sets submitTimeUtc + * @param string $submitTimeUtc Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. * @return $this */ - public function setFieldType($fieldType) + public function setSubmitTimeUtc($submitTimeUtc) { - $this->container['fieldType'] = $fieldType; + $this->container['submitTimeUtc'] = $submitTimeUtc; return $this; } /** - * Gets label + * Gets status * @return string */ - public function getLabel() - { - return $this->container['label']; - } - - /** - * Sets label - * @param string $label - * @return $this - */ - public function setLabel($label) - { - $this->container['label'] = $label; - - return $this; - } - - /** - * Gets customerVisible - * @return bool - */ - public function getCustomerVisible() - { - return $this->container['customerVisible']; - } - - /** - * Sets customerVisible - * @param bool $customerVisible - * @return $this - */ - public function setCustomerVisible($customerVisible) - { - $this->container['customerVisible'] = $customerVisible; - - return $this; - } - - /** - * Gets textMinLength - * @return int - */ - public function getTextMinLength() - { - return $this->container['textMinLength']; - } - - /** - * Sets textMinLength - * @param int $textMinLength - * @return $this - */ - public function setTextMinLength($textMinLength) - { - $this->container['textMinLength'] = $textMinLength; - - return $this; - } - - /** - * Gets textMaxLength - * @return int - */ - public function getTextMaxLength() - { - return $this->container['textMaxLength']; - } - - /** - * Sets textMaxLength - * @param int $textMaxLength - * @return $this - */ - public function setTextMaxLength($textMaxLength) - { - $this->container['textMaxLength'] = $textMaxLength; - - return $this; - } - - /** - * Gets possibleValues - * @return string - */ - public function getPossibleValues() - { - return $this->container['possibleValues']; - } - - /** - * Sets possibleValues - * @param string $possibleValues - * @return $this - */ - public function setPossibleValues($possibleValues) - { - $this->container['possibleValues'] = $possibleValues; - - return $this; - } - - /** - * Gets textDefaultValue - * @return string - */ - public function getTextDefaultValue() - { - return $this->container['textDefaultValue']; - } - - /** - * Sets textDefaultValue - * @param string $textDefaultValue - * @return $this - */ - public function setTextDefaultValue($textDefaultValue) - { - $this->container['textDefaultValue'] = $textDefaultValue; - - return $this; - } - - /** - * Gets merchantId - * @return string - */ - public function getMerchantId() - { - return $this->container['merchantId']; - } - - /** - * Sets merchantId - * @param string $merchantId - * @return $this - */ - public function setMerchantId($merchantId) - { - $this->container['merchantId'] = $merchantId; - - return $this; - } - - /** - * Gets referenceType - * @return string - */ - public function getReferenceType() - { - return $this->container['referenceType']; - } - - /** - * Sets referenceType - * @param string $referenceType - * @return $this - */ - public function setReferenceType($referenceType) - { - $this->container['referenceType'] = $referenceType; - - return $this; - } - - /** - * Gets readOnly - * @return bool - */ - public function getReadOnly() + public function getStatus() { - return $this->container['readOnly']; + return $this->container['status']; } /** - * Sets readOnly - * @param bool $readOnly + * Sets status + * @param string $status The status of the submitted transaction. Possible values are: - `ACCEPTED` - `REJECTED` * @return $this */ - public function setReadOnly($readOnly) + public function setStatus($status) { - $this->container['readOnly'] = $readOnly; + $this->container['status'] = $status; return $this; } /** - * Gets merchantDefinedDataIndex - * @return int + * Gets embedded + * @return \CyberSource\Model\InlineResponse2002Embedded */ - public function getMerchantDefinedDataIndex() + public function getEmbedded() { - return $this->container['merchantDefinedDataIndex']; + return $this->container['embedded']; } /** - * Sets merchantDefinedDataIndex - * @param int $merchantDefinedDataIndex + * Sets embedded + * @param \CyberSource\Model\InlineResponse2002Embedded $embedded * @return $this */ - public function setMerchantDefinedDataIndex($merchantDefinedDataIndex) + public function setEmbedded($embedded) { - $this->container['merchantDefinedDataIndex'] = $merchantDefinedDataIndex; + $this->container['embedded'] = $embedded; return $this; } diff --git a/lib/Model/InlineResponse2001Embedded.php b/lib/Model/InlineResponse2002Embedded.php similarity index 91% rename from lib/Model/InlineResponse2001Embedded.php rename to lib/Model/InlineResponse2002Embedded.php index f53c033b9..2fac6e6cb 100644 --- a/lib/Model/InlineResponse2001Embedded.php +++ b/lib/Model/InlineResponse2002Embedded.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse2001EmbeddedCapture', - 'reversal' => '\CyberSource\Model\InlineResponse2001EmbeddedReversal' + 'capture' => '\CyberSource\Model\InlineResponse2002EmbeddedCapture', + 'reversal' => '\CyberSource\Model\InlineResponse2002EmbeddedReversal' ]; /** @@ -168,7 +168,7 @@ public function valid() /** * Gets capture - * @return \CyberSource\Model\InlineResponse2001EmbeddedCapture + * @return \CyberSource\Model\InlineResponse2002EmbeddedCapture */ public function getCapture() { @@ -177,7 +177,7 @@ public function getCapture() /** * Sets capture - * @param \CyberSource\Model\InlineResponse2001EmbeddedCapture $capture + * @param \CyberSource\Model\InlineResponse2002EmbeddedCapture $capture * @return $this */ public function setCapture($capture) @@ -189,7 +189,7 @@ public function setCapture($capture) /** * Gets reversal - * @return \CyberSource\Model\InlineResponse2001EmbeddedReversal + * @return \CyberSource\Model\InlineResponse2002EmbeddedReversal */ public function getReversal() { @@ -198,7 +198,7 @@ public function getReversal() /** * Sets reversal - * @param \CyberSource\Model\InlineResponse2001EmbeddedReversal $reversal + * @param \CyberSource\Model\InlineResponse2002EmbeddedReversal $reversal * @return $this */ public function setReversal($reversal) diff --git a/lib/Model/InlineResponse2001EmbeddedCapture.php b/lib/Model/InlineResponse2002EmbeddedCapture.php similarity index 93% rename from lib/Model/InlineResponse2001EmbeddedCapture.php rename to lib/Model/InlineResponse2002EmbeddedCapture.php index 76dcda5aa..662d9aab2 100644 --- a/lib/Model/InlineResponse2001EmbeddedCapture.php +++ b/lib/Model/InlineResponse2002EmbeddedCapture.php @@ -1,6 +1,6 @@ 'string', - 'links' => '\CyberSource\Model\InlineResponse2001EmbeddedCaptureLinks' + 'links' => '\CyberSource\Model\InlineResponse2002EmbeddedCaptureLinks' ]; /** @@ -189,7 +189,7 @@ public function setStatus($status) /** * Gets links - * @return \CyberSource\Model\InlineResponse2001EmbeddedCaptureLinks + * @return \CyberSource\Model\InlineResponse2002EmbeddedCaptureLinks */ public function getLinks() { @@ -198,7 +198,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\InlineResponse2001EmbeddedCaptureLinks $links + * @param \CyberSource\Model\InlineResponse2002EmbeddedCaptureLinks $links * @return $this */ public function setLinks($links) diff --git a/lib/Model/InlineResponse2001EmbeddedCaptureLinks.php b/lib/Model/InlineResponse2002EmbeddedCaptureLinks.php similarity index 92% rename from lib/Model/InlineResponse2001EmbeddedCaptureLinks.php rename to lib/Model/InlineResponse2002EmbeddedCaptureLinks.php index 7b1cc8085..2abdc4ce4 100644 --- a/lib/Model/InlineResponse2001EmbeddedCaptureLinks.php +++ b/lib/Model/InlineResponse2002EmbeddedCaptureLinks.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse2001EmbeddedCaptureLinksSelf' + 'self' => '\CyberSource\Model\InlineResponse2002EmbeddedCaptureLinksSelf' ]; /** @@ -162,7 +162,7 @@ public function valid() /** * Gets self - * @return \CyberSource\Model\InlineResponse2001EmbeddedCaptureLinksSelf + * @return \CyberSource\Model\InlineResponse2002EmbeddedCaptureLinksSelf */ public function getSelf() { @@ -171,7 +171,7 @@ public function getSelf() /** * Sets self - * @param \CyberSource\Model\InlineResponse2001EmbeddedCaptureLinksSelf $self + * @param \CyberSource\Model\InlineResponse2002EmbeddedCaptureLinksSelf $self * @return $this */ public function setSelf($self) diff --git a/lib/Model/InlineResponse2001EmbeddedCaptureLinksSelf.php b/lib/Model/InlineResponse2002EmbeddedCaptureLinksSelf.php similarity index 96% rename from lib/Model/InlineResponse2001EmbeddedCaptureLinksSelf.php rename to lib/Model/InlineResponse2002EmbeddedCaptureLinksSelf.php index dd22fbd24..c2142b346 100644 --- a/lib/Model/InlineResponse2001EmbeddedCaptureLinksSelf.php +++ b/lib/Model/InlineResponse2002EmbeddedCaptureLinksSelf.php @@ -1,6 +1,6 @@ 'string', - 'links' => '\CyberSource\Model\InlineResponse2001EmbeddedReversalLinks' + 'links' => '\CyberSource\Model\InlineResponse2002EmbeddedReversalLinks' ]; /** @@ -189,7 +189,7 @@ public function setStatus($status) /** * Gets links - * @return \CyberSource\Model\InlineResponse2001EmbeddedReversalLinks + * @return \CyberSource\Model\InlineResponse2002EmbeddedReversalLinks */ public function getLinks() { @@ -198,7 +198,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\InlineResponse2001EmbeddedReversalLinks $links + * @param \CyberSource\Model\InlineResponse2002EmbeddedReversalLinks $links * @return $this */ public function setLinks($links) diff --git a/lib/Model/InlineResponse2001EmbeddedReversalLinks.php b/lib/Model/InlineResponse2002EmbeddedReversalLinks.php similarity index 92% rename from lib/Model/InlineResponse2001EmbeddedReversalLinks.php rename to lib/Model/InlineResponse2002EmbeddedReversalLinks.php index 486016d37..63ef7f471 100644 --- a/lib/Model/InlineResponse2001EmbeddedReversalLinks.php +++ b/lib/Model/InlineResponse2002EmbeddedReversalLinks.php @@ -1,6 +1,6 @@ '\CyberSource\Model\InlineResponse2001EmbeddedReversalLinksSelf' + 'self' => '\CyberSource\Model\InlineResponse2002EmbeddedReversalLinksSelf' ]; /** @@ -162,7 +162,7 @@ public function valid() /** * Gets self - * @return \CyberSource\Model\InlineResponse2001EmbeddedReversalLinksSelf + * @return \CyberSource\Model\InlineResponse2002EmbeddedReversalLinksSelf */ public function getSelf() { @@ -171,7 +171,7 @@ public function getSelf() /** * Sets self - * @param \CyberSource\Model\InlineResponse2001EmbeddedReversalLinksSelf $self + * @param \CyberSource\Model\InlineResponse2002EmbeddedReversalLinksSelf $self * @return $this */ public function setSelf($self) diff --git a/lib/Model/InlineResponse2001EmbeddedReversalLinksSelf.php b/lib/Model/InlineResponse2002EmbeddedReversalLinksSelf.php similarity index 96% rename from lib/Model/InlineResponse2001EmbeddedReversalLinksSelf.php rename to lib/Model/InlineResponse2002EmbeddedReversalLinksSelf.php index 801fb6f31..5c2bf2044 100644 --- a/lib/Model/InlineResponse2001EmbeddedReversalLinksSelf.php +++ b/lib/Model/InlineResponse2002EmbeddedReversalLinksSelf.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Boardingv1registrationsRegistrationInformation', - 'integrationInformation' => '\CyberSource\Model\InlineResponse2003IntegrationInformation', - 'organizationInformation' => '\CyberSource\Model\Boardingv1registrationsOrganizationInformation', - 'productInformation' => '\CyberSource\Model\Boardingv1registrationsProductInformation', - 'productInformationSetups' => '\CyberSource\Model\InlineResponse2013ProductInformationSetups[]', - 'documentInformation' => '\CyberSource\Model\Boardingv1registrationsDocumentInformation', - 'details' => 'map[string,object[]]' + 'id' => 'int', + 'fieldType' => 'string', + 'label' => 'string', + 'customerVisible' => 'bool', + 'textMinLength' => 'int', + 'textMaxLength' => 'int', + 'possibleValues' => 'string', + 'textDefaultValue' => 'string', + 'merchantId' => 'string', + 'referenceType' => 'string', + 'readOnly' => 'bool', + 'merchantDefinedDataIndex' => 'int' ]; /** @@ -67,13 +72,18 @@ class InlineResponse2003 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'registrationInformation' => null, - 'integrationInformation' => null, - 'organizationInformation' => null, - 'productInformation' => null, - 'productInformationSetups' => null, - 'documentInformation' => null, - 'details' => null + 'id' => 'int64', + 'fieldType' => null, + 'label' => null, + 'customerVisible' => null, + 'textMinLength' => 'int32', + 'textMaxLength' => 'int32', + 'possibleValues' => null, + 'textDefaultValue' => null, + 'merchantId' => null, + 'referenceType' => null, + 'readOnly' => null, + 'merchantDefinedDataIndex' => 'int32' ]; public static function swaggerTypes() @@ -91,13 +101,18 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'registrationInformation' => 'registrationInformation', - 'integrationInformation' => 'integrationInformation', - 'organizationInformation' => 'organizationInformation', - 'productInformation' => 'productInformation', - 'productInformationSetups' => 'productInformationSetups', - 'documentInformation' => 'documentInformation', - 'details' => 'details' + 'id' => 'id', + 'fieldType' => 'fieldType', + 'label' => 'label', + 'customerVisible' => 'customerVisible', + 'textMinLength' => 'textMinLength', + 'textMaxLength' => 'textMaxLength', + 'possibleValues' => 'possibleValues', + 'textDefaultValue' => 'textDefaultValue', + 'merchantId' => 'merchantId', + 'referenceType' => 'referenceType', + 'readOnly' => 'readOnly', + 'merchantDefinedDataIndex' => 'merchantDefinedDataIndex' ]; @@ -106,13 +121,18 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'registrationInformation' => 'setRegistrationInformation', - 'integrationInformation' => 'setIntegrationInformation', - 'organizationInformation' => 'setOrganizationInformation', - 'productInformation' => 'setProductInformation', - 'productInformationSetups' => 'setProductInformationSetups', - 'documentInformation' => 'setDocumentInformation', - 'details' => 'setDetails' + 'id' => 'setId', + 'fieldType' => 'setFieldType', + 'label' => 'setLabel', + 'customerVisible' => 'setCustomerVisible', + 'textMinLength' => 'setTextMinLength', + 'textMaxLength' => 'setTextMaxLength', + 'possibleValues' => 'setPossibleValues', + 'textDefaultValue' => 'setTextDefaultValue', + 'merchantId' => 'setMerchantId', + 'referenceType' => 'setReferenceType', + 'readOnly' => 'setReadOnly', + 'merchantDefinedDataIndex' => 'setMerchantDefinedDataIndex' ]; @@ -121,13 +141,18 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'registrationInformation' => 'getRegistrationInformation', - 'integrationInformation' => 'getIntegrationInformation', - 'organizationInformation' => 'getOrganizationInformation', - 'productInformation' => 'getProductInformation', - 'productInformationSetups' => 'getProductInformationSetups', - 'documentInformation' => 'getDocumentInformation', - 'details' => 'getDetails' + 'id' => 'getId', + 'fieldType' => 'getFieldType', + 'label' => 'getLabel', + 'customerVisible' => 'getCustomerVisible', + 'textMinLength' => 'getTextMinLength', + 'textMaxLength' => 'getTextMaxLength', + 'possibleValues' => 'getPossibleValues', + 'textDefaultValue' => 'getTextDefaultValue', + 'merchantId' => 'getMerchantId', + 'referenceType' => 'getReferenceType', + 'readOnly' => 'getReadOnly', + 'merchantDefinedDataIndex' => 'getMerchantDefinedDataIndex' ]; public static function attributeMap() @@ -161,13 +186,18 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['registrationInformation'] = isset($data['registrationInformation']) ? $data['registrationInformation'] : null; - $this->container['integrationInformation'] = isset($data['integrationInformation']) ? $data['integrationInformation'] : null; - $this->container['organizationInformation'] = isset($data['organizationInformation']) ? $data['organizationInformation'] : null; - $this->container['productInformation'] = isset($data['productInformation']) ? $data['productInformation'] : null; - $this->container['productInformationSetups'] = isset($data['productInformationSetups']) ? $data['productInformationSetups'] : null; - $this->container['documentInformation'] = isset($data['documentInformation']) ? $data['documentInformation'] : null; - $this->container['details'] = isset($data['details']) ? $data['details'] : null; + $this->container['id'] = isset($data['id']) ? $data['id'] : null; + $this->container['fieldType'] = isset($data['fieldType']) ? $data['fieldType'] : null; + $this->container['label'] = isset($data['label']) ? $data['label'] : null; + $this->container['customerVisible'] = isset($data['customerVisible']) ? $data['customerVisible'] : null; + $this->container['textMinLength'] = isset($data['textMinLength']) ? $data['textMinLength'] : null; + $this->container['textMaxLength'] = isset($data['textMaxLength']) ? $data['textMaxLength'] : null; + $this->container['possibleValues'] = isset($data['possibleValues']) ? $data['possibleValues'] : null; + $this->container['textDefaultValue'] = isset($data['textDefaultValue']) ? $data['textDefaultValue'] : null; + $this->container['merchantId'] = isset($data['merchantId']) ? $data['merchantId'] : null; + $this->container['referenceType'] = isset($data['referenceType']) ? $data['referenceType'] : null; + $this->container['readOnly'] = isset($data['readOnly']) ? $data['readOnly'] : null; + $this->container['merchantDefinedDataIndex'] = isset($data['merchantDefinedDataIndex']) ? $data['merchantDefinedDataIndex'] : null; } /** @@ -196,148 +226,253 @@ public function valid() /** - * Gets registrationInformation - * @return \CyberSource\Model\Boardingv1registrationsRegistrationInformation + * Gets id + * @return int */ - public function getRegistrationInformation() + public function getId() { - return $this->container['registrationInformation']; + return $this->container['id']; } /** - * Sets registrationInformation - * @param \CyberSource\Model\Boardingv1registrationsRegistrationInformation $registrationInformation + * Sets id + * @param int $id * @return $this */ - public function setRegistrationInformation($registrationInformation) + public function setId($id) { - $this->container['registrationInformation'] = $registrationInformation; + $this->container['id'] = $id; return $this; } /** - * Gets integrationInformation - * @return \CyberSource\Model\InlineResponse2003IntegrationInformation + * Gets fieldType + * @return string + */ + public function getFieldType() + { + return $this->container['fieldType']; + } + + /** + * Sets fieldType + * @param string $fieldType + * @return $this + */ + public function setFieldType($fieldType) + { + $this->container['fieldType'] = $fieldType; + + return $this; + } + + /** + * Gets label + * @return string + */ + public function getLabel() + { + return $this->container['label']; + } + + /** + * Sets label + * @param string $label + * @return $this + */ + public function setLabel($label) + { + $this->container['label'] = $label; + + return $this; + } + + /** + * Gets customerVisible + * @return bool */ - public function getIntegrationInformation() + public function getCustomerVisible() { - return $this->container['integrationInformation']; + return $this->container['customerVisible']; } /** - * Sets integrationInformation - * @param \CyberSource\Model\InlineResponse2003IntegrationInformation $integrationInformation + * Sets customerVisible + * @param bool $customerVisible * @return $this */ - public function setIntegrationInformation($integrationInformation) + public function setCustomerVisible($customerVisible) { - $this->container['integrationInformation'] = $integrationInformation; + $this->container['customerVisible'] = $customerVisible; return $this; } /** - * Gets organizationInformation - * @return \CyberSource\Model\Boardingv1registrationsOrganizationInformation + * Gets textMinLength + * @return int */ - public function getOrganizationInformation() + public function getTextMinLength() { - return $this->container['organizationInformation']; + return $this->container['textMinLength']; } /** - * Sets organizationInformation - * @param \CyberSource\Model\Boardingv1registrationsOrganizationInformation $organizationInformation + * Sets textMinLength + * @param int $textMinLength * @return $this */ - public function setOrganizationInformation($organizationInformation) + public function setTextMinLength($textMinLength) { - $this->container['organizationInformation'] = $organizationInformation; + $this->container['textMinLength'] = $textMinLength; return $this; } /** - * Gets productInformation - * @return \CyberSource\Model\Boardingv1registrationsProductInformation + * Gets textMaxLength + * @return int */ - public function getProductInformation() + public function getTextMaxLength() { - return $this->container['productInformation']; + return $this->container['textMaxLength']; } /** - * Sets productInformation - * @param \CyberSource\Model\Boardingv1registrationsProductInformation $productInformation + * Sets textMaxLength + * @param int $textMaxLength * @return $this */ - public function setProductInformation($productInformation) + public function setTextMaxLength($textMaxLength) { - $this->container['productInformation'] = $productInformation; + $this->container['textMaxLength'] = $textMaxLength; return $this; } /** - * Gets productInformationSetups - * @return \CyberSource\Model\InlineResponse2013ProductInformationSetups[] + * Gets possibleValues + * @return string + */ + public function getPossibleValues() + { + return $this->container['possibleValues']; + } + + /** + * Sets possibleValues + * @param string $possibleValues + * @return $this + */ + public function setPossibleValues($possibleValues) + { + $this->container['possibleValues'] = $possibleValues; + + return $this; + } + + /** + * Gets textDefaultValue + * @return string + */ + public function getTextDefaultValue() + { + return $this->container['textDefaultValue']; + } + + /** + * Sets textDefaultValue + * @param string $textDefaultValue + * @return $this + */ + public function setTextDefaultValue($textDefaultValue) + { + $this->container['textDefaultValue'] = $textDefaultValue; + + return $this; + } + + /** + * Gets merchantId + * @return string + */ + public function getMerchantId() + { + return $this->container['merchantId']; + } + + /** + * Sets merchantId + * @param string $merchantId + * @return $this + */ + public function setMerchantId($merchantId) + { + $this->container['merchantId'] = $merchantId; + + return $this; + } + + /** + * Gets referenceType + * @return string */ - public function getProductInformationSetups() + public function getReferenceType() { - return $this->container['productInformationSetups']; + return $this->container['referenceType']; } /** - * Sets productInformationSetups - * @param \CyberSource\Model\InlineResponse2013ProductInformationSetups[] $productInformationSetups + * Sets referenceType + * @param string $referenceType * @return $this */ - public function setProductInformationSetups($productInformationSetups) + public function setReferenceType($referenceType) { - $this->container['productInformationSetups'] = $productInformationSetups; + $this->container['referenceType'] = $referenceType; return $this; } /** - * Gets documentInformation - * @return \CyberSource\Model\Boardingv1registrationsDocumentInformation + * Gets readOnly + * @return bool */ - public function getDocumentInformation() + public function getReadOnly() { - return $this->container['documentInformation']; + return $this->container['readOnly']; } /** - * Sets documentInformation - * @param \CyberSource\Model\Boardingv1registrationsDocumentInformation $documentInformation + * Sets readOnly + * @param bool $readOnly * @return $this */ - public function setDocumentInformation($documentInformation) + public function setReadOnly($readOnly) { - $this->container['documentInformation'] = $documentInformation; + $this->container['readOnly'] = $readOnly; return $this; } /** - * Gets details - * @return map[string,object[]] + * Gets merchantDefinedDataIndex + * @return int */ - public function getDetails() + public function getMerchantDefinedDataIndex() { - return $this->container['details']; + return $this->container['merchantDefinedDataIndex']; } /** - * Sets details - * @param map[string,object[]] $details + * Sets merchantDefinedDataIndex + * @param int $merchantDefinedDataIndex * @return $this */ - public function setDetails($details) + public function setMerchantDefinedDataIndex($merchantDefinedDataIndex) { - $this->container['details'] = $details; + $this->container['merchantDefinedDataIndex'] = $merchantDefinedDataIndex; return $this; } diff --git a/lib/Model/InlineResponse2004.php b/lib/Model/InlineResponse2004.php index 4b92c1996..0364930a8 100644 --- a/lib/Model/InlineResponse2004.php +++ b/lib/Model/InlineResponse2004.php @@ -53,9 +53,13 @@ class InlineResponse2004 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'productId' => 'string', - 'productName' => 'string', - 'eventTypes' => '\CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[]' + 'registrationInformation' => '\CyberSource\Model\Boardingv1registrationsRegistrationInformation', + 'integrationInformation' => '\CyberSource\Model\InlineResponse2004IntegrationInformation', + 'organizationInformation' => '\CyberSource\Model\Boardingv1registrationsOrganizationInformation', + 'productInformation' => '\CyberSource\Model\Boardingv1registrationsProductInformation', + 'productInformationSetups' => '\CyberSource\Model\InlineResponse2013ProductInformationSetups[]', + 'documentInformation' => '\CyberSource\Model\Boardingv1registrationsDocumentInformation', + 'details' => 'map[string,object[]]' ]; /** @@ -63,9 +67,13 @@ class InlineResponse2004 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'productId' => null, - 'productName' => null, - 'eventTypes' => null + 'registrationInformation' => null, + 'integrationInformation' => null, + 'organizationInformation' => null, + 'productInformation' => null, + 'productInformationSetups' => null, + 'documentInformation' => null, + 'details' => null ]; public static function swaggerTypes() @@ -83,9 +91,13 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'productId' => 'productId', - 'productName' => 'productName', - 'eventTypes' => 'eventTypes' + 'registrationInformation' => 'registrationInformation', + 'integrationInformation' => 'integrationInformation', + 'organizationInformation' => 'organizationInformation', + 'productInformation' => 'productInformation', + 'productInformationSetups' => 'productInformationSetups', + 'documentInformation' => 'documentInformation', + 'details' => 'details' ]; @@ -94,9 +106,13 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'productId' => 'setProductId', - 'productName' => 'setProductName', - 'eventTypes' => 'setEventTypes' + 'registrationInformation' => 'setRegistrationInformation', + 'integrationInformation' => 'setIntegrationInformation', + 'organizationInformation' => 'setOrganizationInformation', + 'productInformation' => 'setProductInformation', + 'productInformationSetups' => 'setProductInformationSetups', + 'documentInformation' => 'setDocumentInformation', + 'details' => 'setDetails' ]; @@ -105,9 +121,13 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'productId' => 'getProductId', - 'productName' => 'getProductName', - 'eventTypes' => 'getEventTypes' + 'registrationInformation' => 'getRegistrationInformation', + 'integrationInformation' => 'getIntegrationInformation', + 'organizationInformation' => 'getOrganizationInformation', + 'productInformation' => 'getProductInformation', + 'productInformationSetups' => 'getProductInformationSetups', + 'documentInformation' => 'getDocumentInformation', + 'details' => 'getDetails' ]; public static function attributeMap() @@ -141,9 +161,13 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['productId'] = isset($data['productId']) ? $data['productId'] : null; - $this->container['productName'] = isset($data['productName']) ? $data['productName'] : null; - $this->container['eventTypes'] = isset($data['eventTypes']) ? $data['eventTypes'] : null; + $this->container['registrationInformation'] = isset($data['registrationInformation']) ? $data['registrationInformation'] : null; + $this->container['integrationInformation'] = isset($data['integrationInformation']) ? $data['integrationInformation'] : null; + $this->container['organizationInformation'] = isset($data['organizationInformation']) ? $data['organizationInformation'] : null; + $this->container['productInformation'] = isset($data['productInformation']) ? $data['productInformation'] : null; + $this->container['productInformationSetups'] = isset($data['productInformationSetups']) ? $data['productInformationSetups'] : null; + $this->container['documentInformation'] = isset($data['documentInformation']) ? $data['documentInformation'] : null; + $this->container['details'] = isset($data['details']) ? $data['details'] : null; } /** @@ -172,64 +196,148 @@ public function valid() /** - * Gets productId - * @return string + * Gets registrationInformation + * @return \CyberSource\Model\Boardingv1registrationsRegistrationInformation */ - public function getProductId() + public function getRegistrationInformation() { - return $this->container['productId']; + return $this->container['registrationInformation']; } /** - * Sets productId - * @param string $productId Product ID. + * Sets registrationInformation + * @param \CyberSource\Model\Boardingv1registrationsRegistrationInformation $registrationInformation * @return $this */ - public function setProductId($productId) + public function setRegistrationInformation($registrationInformation) { - $this->container['productId'] = $productId; + $this->container['registrationInformation'] = $registrationInformation; return $this; } /** - * Gets productName - * @return string + * Gets integrationInformation + * @return \CyberSource\Model\InlineResponse2004IntegrationInformation + */ + public function getIntegrationInformation() + { + return $this->container['integrationInformation']; + } + + /** + * Sets integrationInformation + * @param \CyberSource\Model\InlineResponse2004IntegrationInformation $integrationInformation + * @return $this + */ + public function setIntegrationInformation($integrationInformation) + { + $this->container['integrationInformation'] = $integrationInformation; + + return $this; + } + + /** + * Gets organizationInformation + * @return \CyberSource\Model\Boardingv1registrationsOrganizationInformation + */ + public function getOrganizationInformation() + { + return $this->container['organizationInformation']; + } + + /** + * Sets organizationInformation + * @param \CyberSource\Model\Boardingv1registrationsOrganizationInformation $organizationInformation + * @return $this + */ + public function setOrganizationInformation($organizationInformation) + { + $this->container['organizationInformation'] = $organizationInformation; + + return $this; + } + + /** + * Gets productInformation + * @return \CyberSource\Model\Boardingv1registrationsProductInformation + */ + public function getProductInformation() + { + return $this->container['productInformation']; + } + + /** + * Sets productInformation + * @param \CyberSource\Model\Boardingv1registrationsProductInformation $productInformation + * @return $this + */ + public function setProductInformation($productInformation) + { + $this->container['productInformation'] = $productInformation; + + return $this; + } + + /** + * Gets productInformationSetups + * @return \CyberSource\Model\InlineResponse2013ProductInformationSetups[] + */ + public function getProductInformationSetups() + { + return $this->container['productInformationSetups']; + } + + /** + * Sets productInformationSetups + * @param \CyberSource\Model\InlineResponse2013ProductInformationSetups[] $productInformationSetups + * @return $this + */ + public function setProductInformationSetups($productInformationSetups) + { + $this->container['productInformationSetups'] = $productInformationSetups; + + return $this; + } + + /** + * Gets documentInformation + * @return \CyberSource\Model\Boardingv1registrationsDocumentInformation */ - public function getProductName() + public function getDocumentInformation() { - return $this->container['productName']; + return $this->container['documentInformation']; } /** - * Sets productName - * @param string $productName Product Name. + * Sets documentInformation + * @param \CyberSource\Model\Boardingv1registrationsDocumentInformation $documentInformation * @return $this */ - public function setProductName($productName) + public function setDocumentInformation($documentInformation) { - $this->container['productName'] = $productName; + $this->container['documentInformation'] = $documentInformation; return $this; } /** - * Gets eventTypes - * @return \CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[] + * Gets details + * @return map[string,object[]] */ - public function getEventTypes() + public function getDetails() { - return $this->container['eventTypes']; + return $this->container['details']; } /** - * Sets eventTypes - * @param \CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[] $eventTypes + * Sets details + * @param map[string,object[]] $details * @return $this */ - public function setEventTypes($eventTypes) + public function setDetails($details) { - $this->container['eventTypes'] = $eventTypes; + $this->container['details'] = $details; return $this; } diff --git a/lib/Model/InlineResponse2003IntegrationInformation.php b/lib/Model/InlineResponse2004IntegrationInformation.php similarity index 93% rename from lib/Model/InlineResponse2003IntegrationInformation.php rename to lib/Model/InlineResponse2004IntegrationInformation.php index c9e482482..fe971f926 100644 --- a/lib/Model/InlineResponse2003IntegrationInformation.php +++ b/lib/Model/InlineResponse2004IntegrationInformation.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Boardingv1registrationsIntegrationInformationOauth2[]', - 'tenantConfigurations' => '\CyberSource\Model\InlineResponse2003IntegrationInformationTenantConfigurations[]' + 'tenantConfigurations' => '\CyberSource\Model\InlineResponse2004IntegrationInformationTenantConfigurations[]' ]; /** @@ -188,7 +188,7 @@ public function setOauth2($oauth2) /** * Gets tenantConfigurations - * @return \CyberSource\Model\InlineResponse2003IntegrationInformationTenantConfigurations[] + * @return \CyberSource\Model\InlineResponse2004IntegrationInformationTenantConfigurations[] */ public function getTenantConfigurations() { @@ -197,7 +197,7 @@ public function getTenantConfigurations() /** * Sets tenantConfigurations - * @param \CyberSource\Model\InlineResponse2003IntegrationInformationTenantConfigurations[] $tenantConfigurations tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. + * @param \CyberSource\Model\InlineResponse2004IntegrationInformationTenantConfigurations[] $tenantConfigurations tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. * @return $this */ public function setTenantConfigurations($tenantConfigurations) diff --git a/lib/Model/InlineResponse2003IntegrationInformationTenantConfigurations.php b/lib/Model/InlineResponse2004IntegrationInformationTenantConfigurations.php similarity index 97% rename from lib/Model/InlineResponse2003IntegrationInformationTenantConfigurations.php rename to lib/Model/InlineResponse2004IntegrationInformationTenantConfigurations.php index 2f9e72b7b..c9d492f0f 100644 --- a/lib/Model/InlineResponse2003IntegrationInformationTenantConfigurations.php +++ b/lib/Model/InlineResponse2004IntegrationInformationTenantConfigurations.php @@ -1,6 +1,6 @@ 'string', - 'organizationId' => 'string', - 'products' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[]', - 'webhookUrl' => 'string', - 'healthCheckUrl' => 'string', - 'status' => 'string', - 'name' => 'string', - 'description' => 'string', - 'retryPolicy' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy', - 'securityPolicy' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy', - 'createdOn' => 'string', - 'notificationScope' => 'string' + 'productId' => 'string', + 'productName' => 'string', + 'eventTypes' => '\CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[]' ]; /** @@ -72,18 +63,9 @@ class InlineResponse2005 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'webhookId' => null, - 'organizationId' => null, - 'products' => null, - 'webhookUrl' => null, - 'healthCheckUrl' => null, - 'status' => null, - 'name' => null, - 'description' => null, - 'retryPolicy' => null, - 'securityPolicy' => null, - 'createdOn' => null, - 'notificationScope' => null + 'productId' => null, + 'productName' => null, + 'eventTypes' => null ]; public static function swaggerTypes() @@ -101,18 +83,9 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'webhookId' => 'webhookId', - 'organizationId' => 'organizationId', - 'products' => 'products', - 'webhookUrl' => 'webhookUrl', - 'healthCheckUrl' => 'healthCheckUrl', - 'status' => 'status', - 'name' => 'name', - 'description' => 'description', - 'retryPolicy' => 'retryPolicy', - 'securityPolicy' => 'securityPolicy', - 'createdOn' => 'createdOn', - 'notificationScope' => 'notificationScope' + 'productId' => 'productId', + 'productName' => 'productName', + 'eventTypes' => 'eventTypes' ]; @@ -121,18 +94,9 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'webhookId' => 'setWebhookId', - 'organizationId' => 'setOrganizationId', - 'products' => 'setProducts', - 'webhookUrl' => 'setWebhookUrl', - 'healthCheckUrl' => 'setHealthCheckUrl', - 'status' => 'setStatus', - 'name' => 'setName', - 'description' => 'setDescription', - 'retryPolicy' => 'setRetryPolicy', - 'securityPolicy' => 'setSecurityPolicy', - 'createdOn' => 'setCreatedOn', - 'notificationScope' => 'setNotificationScope' + 'productId' => 'setProductId', + 'productName' => 'setProductName', + 'eventTypes' => 'setEventTypes' ]; @@ -141,18 +105,9 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'webhookId' => 'getWebhookId', - 'organizationId' => 'getOrganizationId', - 'products' => 'getProducts', - 'webhookUrl' => 'getWebhookUrl', - 'healthCheckUrl' => 'getHealthCheckUrl', - 'status' => 'getStatus', - 'name' => 'getName', - 'description' => 'getDescription', - 'retryPolicy' => 'getRetryPolicy', - 'securityPolicy' => 'getSecurityPolicy', - 'createdOn' => 'getCreatedOn', - 'notificationScope' => 'getNotificationScope' + 'productId' => 'getProductId', + 'productName' => 'getProductName', + 'eventTypes' => 'getEventTypes' ]; public static function attributeMap() @@ -186,18 +141,9 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['webhookId'] = isset($data['webhookId']) ? $data['webhookId'] : null; - $this->container['organizationId'] = isset($data['organizationId']) ? $data['organizationId'] : null; - $this->container['products'] = isset($data['products']) ? $data['products'] : null; - $this->container['webhookUrl'] = isset($data['webhookUrl']) ? $data['webhookUrl'] : null; - $this->container['healthCheckUrl'] = isset($data['healthCheckUrl']) ? $data['healthCheckUrl'] : null; - $this->container['status'] = isset($data['status']) ? $data['status'] : 'INACTIVE'; - $this->container['name'] = isset($data['name']) ? $data['name'] : null; - $this->container['description'] = isset($data['description']) ? $data['description'] : null; - $this->container['retryPolicy'] = isset($data['retryPolicy']) ? $data['retryPolicy'] : null; - $this->container['securityPolicy'] = isset($data['securityPolicy']) ? $data['securityPolicy'] : null; - $this->container['createdOn'] = isset($data['createdOn']) ? $data['createdOn'] : null; - $this->container['notificationScope'] = isset($data['notificationScope']) ? $data['notificationScope'] : 'DESCENDANTS'; + $this->container['productId'] = isset($data['productId']) ? $data['productId'] : null; + $this->container['productName'] = isset($data['productName']) ? $data['productName'] : null; + $this->container['eventTypes'] = isset($data['eventTypes']) ? $data['eventTypes'] : null; } /** @@ -226,253 +172,64 @@ public function valid() /** - * Gets webhookId + * Gets productId * @return string */ - public function getWebhookId() + public function getProductId() { - return $this->container['webhookId']; + return $this->container['productId']; } /** - * Sets webhookId - * @param string $webhookId Webhook Id. This is generated by the server. + * Sets productId + * @param string $productId Product ID. * @return $this */ - public function setWebhookId($webhookId) + public function setProductId($productId) { - $this->container['webhookId'] = $webhookId; + $this->container['productId'] = $productId; return $this; } /** - * Gets organizationId + * Gets productName * @return string */ - public function getOrganizationId() + public function getProductName() { - return $this->container['organizationId']; + return $this->container['productName']; } /** - * Sets organizationId - * @param string $organizationId Organization ID. + * Sets productName + * @param string $productName Product Name. * @return $this */ - public function setOrganizationId($organizationId) + public function setProductName($productName) { - $this->container['organizationId'] = $organizationId; + $this->container['productName'] = $productName; return $this; } /** - * Gets products - * @return \CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[] + * Gets eventTypes + * @return \CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[] */ - public function getProducts() + public function getEventTypes() { - return $this->container['products']; + return $this->container['eventTypes']; } /** - * Sets products - * @param \CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[] $products + * Sets eventTypes + * @param \CyberSource\Model\Notificationsubscriptionsv2productsorganizationIdEventTypes[] $eventTypes * @return $this */ - public function setProducts($products) + public function setEventTypes($eventTypes) { - $this->container['products'] = $products; - - return $this; - } - - /** - * Gets webhookUrl - * @return string - */ - public function getWebhookUrl() - { - return $this->container['webhookUrl']; - } - - /** - * Sets webhookUrl - * @param string $webhookUrl The client's endpoint (URL) to receive webhooks. - * @return $this - */ - public function setWebhookUrl($webhookUrl) - { - $this->container['webhookUrl'] = $webhookUrl; - - return $this; - } - - /** - * Gets healthCheckUrl - * @return string - */ - public function getHealthCheckUrl() - { - return $this->container['healthCheckUrl']; - } - - /** - * Sets healthCheckUrl - * @param string $healthCheckUrl The client's health check endpoint (URL). - * @return $this - */ - public function setHealthCheckUrl($healthCheckUrl) - { - $this->container['healthCheckUrl'] = $healthCheckUrl; - - return $this; - } - - /** - * Gets status - * @return string - */ - public function getStatus() - { - return $this->container['status']; - } - - /** - * Sets status - * @param string $status Webhook status. - * @return $this - */ - public function setStatus($status) - { - $this->container['status'] = $status; - - return $this; - } - - /** - * Gets name - * @return string - */ - public function getName() - { - return $this->container['name']; - } - - /** - * Sets name - * @param string $name Client friendly webhook name. - * @return $this - */ - public function setName($name) - { - $this->container['name'] = $name; - - return $this; - } - - /** - * Gets description - * @return string - */ - public function getDescription() - { - return $this->container['description']; - } - - /** - * Sets description - * @param string $description Client friendly webhook description. - * @return $this - */ - public function setDescription($description) - { - $this->container['description'] = $description; - - return $this; - } - - /** - * Gets retryPolicy - * @return \CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy - */ - public function getRetryPolicy() - { - return $this->container['retryPolicy']; - } - - /** - * Sets retryPolicy - * @param \CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy $retryPolicy - * @return $this - */ - public function setRetryPolicy($retryPolicy) - { - $this->container['retryPolicy'] = $retryPolicy; - - return $this; - } - - /** - * Gets securityPolicy - * @return \CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy - */ - public function getSecurityPolicy() - { - return $this->container['securityPolicy']; - } - - /** - * Sets securityPolicy - * @param \CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy $securityPolicy - * @return $this - */ - public function setSecurityPolicy($securityPolicy) - { - $this->container['securityPolicy'] = $securityPolicy; - - return $this; - } - - /** - * Gets createdOn - * @return string - */ - public function getCreatedOn() - { - return $this->container['createdOn']; - } - - /** - * Sets createdOn - * @param string $createdOn Date on which webhook was created/registered. - * @return $this - */ - public function setCreatedOn($createdOn) - { - $this->container['createdOn'] = $createdOn; - - return $this; - } - - /** - * Gets notificationScope - * @return string - */ - public function getNotificationScope() - { - return $this->container['notificationScope']; - } - - /** - * Sets notificationScope - * @param string $notificationScope The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS - * @return $this - */ - public function setNotificationScope($notificationScope) - { - $this->container['notificationScope'] = $notificationScope; + $this->container['eventTypes'] = $eventTypes; return $this; } diff --git a/lib/Model/InlineResponse2006.php b/lib/Model/InlineResponse2006.php index 44d56c37f..239248b5a 100644 --- a/lib/Model/InlineResponse2006.php +++ b/lib/Model/InlineResponse2006.php @@ -64,7 +64,6 @@ class InlineResponse2006 implements ArrayAccess 'retryPolicy' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy', 'securityPolicy' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy', 'createdOn' => 'string', - 'updatedOn' => 'string', 'notificationScope' => 'string' ]; @@ -84,7 +83,6 @@ class InlineResponse2006 implements ArrayAccess 'retryPolicy' => null, 'securityPolicy' => null, 'createdOn' => null, - 'updatedOn' => null, 'notificationScope' => null ]; @@ -114,7 +112,6 @@ public static function swaggerFormats() 'retryPolicy' => 'retryPolicy', 'securityPolicy' => 'securityPolicy', 'createdOn' => 'createdOn', - 'updatedOn' => 'updatedOn', 'notificationScope' => 'notificationScope' ]; @@ -135,7 +132,6 @@ public static function swaggerFormats() 'retryPolicy' => 'setRetryPolicy', 'securityPolicy' => 'setSecurityPolicy', 'createdOn' => 'setCreatedOn', - 'updatedOn' => 'setUpdatedOn', 'notificationScope' => 'setNotificationScope' ]; @@ -156,7 +152,6 @@ public static function swaggerFormats() 'retryPolicy' => 'getRetryPolicy', 'securityPolicy' => 'getSecurityPolicy', 'createdOn' => 'getCreatedOn', - 'updatedOn' => 'getUpdatedOn', 'notificationScope' => 'getNotificationScope' ]; @@ -202,7 +197,6 @@ public function __construct(array $data = null) $this->container['retryPolicy'] = isset($data['retryPolicy']) ? $data['retryPolicy'] : null; $this->container['securityPolicy'] = isset($data['securityPolicy']) ? $data['securityPolicy'] : null; $this->container['createdOn'] = isset($data['createdOn']) ? $data['createdOn'] : null; - $this->container['updatedOn'] = isset($data['updatedOn']) ? $data['updatedOn'] : null; $this->container['notificationScope'] = isset($data['notificationScope']) ? $data['notificationScope'] : 'DESCENDANTS'; } @@ -462,27 +456,6 @@ public function setCreatedOn($createdOn) return $this; } - /** - * Gets updatedOn - * @return string - */ - public function getUpdatedOn() - { - return $this->container['updatedOn']; - } - - /** - * Sets updatedOn - * @param string $updatedOn Date on which webhook was most recently updated. - * @return $this - */ - public function setUpdatedOn($updatedOn) - { - $this->container['updatedOn'] = $updatedOn; - - return $this; - } - /** * Gets notificationScope * @return string diff --git a/lib/Model/InlineResponse2007.php b/lib/Model/InlineResponse2007.php index acddb40b1..938d0d498 100644 --- a/lib/Model/InlineResponse2007.php +++ b/lib/Model/InlineResponse2007.php @@ -53,12 +53,19 @@ class InlineResponse2007 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'totalCount' => 'int', - 'offset' => 'int', - 'limit' => 'int', - 'sort' => 'string', - 'count' => 'int', - 'devices' => '\CyberSource\Model\InlineResponse2007Devices[]' + 'webhookId' => 'string', + 'organizationId' => 'string', + 'products' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[]', + 'webhookUrl' => 'string', + 'healthCheckUrl' => 'string', + 'status' => 'string', + 'name' => 'string', + 'description' => 'string', + 'retryPolicy' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy', + 'securityPolicy' => '\CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy', + 'createdOn' => 'string', + 'updatedOn' => 'string', + 'notificationScope' => 'string' ]; /** @@ -66,12 +73,19 @@ class InlineResponse2007 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'totalCount' => null, - 'offset' => null, - 'limit' => null, - 'sort' => null, - 'count' => null, - 'devices' => null + 'webhookId' => null, + 'organizationId' => null, + 'products' => null, + 'webhookUrl' => null, + 'healthCheckUrl' => null, + 'status' => null, + 'name' => null, + 'description' => null, + 'retryPolicy' => null, + 'securityPolicy' => null, + 'createdOn' => null, + 'updatedOn' => null, + 'notificationScope' => null ]; public static function swaggerTypes() @@ -89,12 +103,19 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'totalCount' => 'totalCount', - 'offset' => 'offset', - 'limit' => 'limit', - 'sort' => 'sort', - 'count' => 'count', - 'devices' => 'devices' + 'webhookId' => 'webhookId', + 'organizationId' => 'organizationId', + 'products' => 'products', + 'webhookUrl' => 'webhookUrl', + 'healthCheckUrl' => 'healthCheckUrl', + 'status' => 'status', + 'name' => 'name', + 'description' => 'description', + 'retryPolicy' => 'retryPolicy', + 'securityPolicy' => 'securityPolicy', + 'createdOn' => 'createdOn', + 'updatedOn' => 'updatedOn', + 'notificationScope' => 'notificationScope' ]; @@ -103,12 +124,19 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'totalCount' => 'setTotalCount', - 'offset' => 'setOffset', - 'limit' => 'setLimit', - 'sort' => 'setSort', - 'count' => 'setCount', - 'devices' => 'setDevices' + 'webhookId' => 'setWebhookId', + 'organizationId' => 'setOrganizationId', + 'products' => 'setProducts', + 'webhookUrl' => 'setWebhookUrl', + 'healthCheckUrl' => 'setHealthCheckUrl', + 'status' => 'setStatus', + 'name' => 'setName', + 'description' => 'setDescription', + 'retryPolicy' => 'setRetryPolicy', + 'securityPolicy' => 'setSecurityPolicy', + 'createdOn' => 'setCreatedOn', + 'updatedOn' => 'setUpdatedOn', + 'notificationScope' => 'setNotificationScope' ]; @@ -117,12 +145,19 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'totalCount' => 'getTotalCount', - 'offset' => 'getOffset', - 'limit' => 'getLimit', - 'sort' => 'getSort', - 'count' => 'getCount', - 'devices' => 'getDevices' + 'webhookId' => 'getWebhookId', + 'organizationId' => 'getOrganizationId', + 'products' => 'getProducts', + 'webhookUrl' => 'getWebhookUrl', + 'healthCheckUrl' => 'getHealthCheckUrl', + 'status' => 'getStatus', + 'name' => 'getName', + 'description' => 'getDescription', + 'retryPolicy' => 'getRetryPolicy', + 'securityPolicy' => 'getSecurityPolicy', + 'createdOn' => 'getCreatedOn', + 'updatedOn' => 'getUpdatedOn', + 'notificationScope' => 'getNotificationScope' ]; public static function attributeMap() @@ -156,12 +191,19 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['totalCount'] = isset($data['totalCount']) ? $data['totalCount'] : null; - $this->container['offset'] = isset($data['offset']) ? $data['offset'] : null; - $this->container['limit'] = isset($data['limit']) ? $data['limit'] : null; - $this->container['sort'] = isset($data['sort']) ? $data['sort'] : null; - $this->container['count'] = isset($data['count']) ? $data['count'] : null; - $this->container['devices'] = isset($data['devices']) ? $data['devices'] : null; + $this->container['webhookId'] = isset($data['webhookId']) ? $data['webhookId'] : null; + $this->container['organizationId'] = isset($data['organizationId']) ? $data['organizationId'] : null; + $this->container['products'] = isset($data['products']) ? $data['products'] : null; + $this->container['webhookUrl'] = isset($data['webhookUrl']) ? $data['webhookUrl'] : null; + $this->container['healthCheckUrl'] = isset($data['healthCheckUrl']) ? $data['healthCheckUrl'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : 'INACTIVE'; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['description'] = isset($data['description']) ? $data['description'] : null; + $this->container['retryPolicy'] = isset($data['retryPolicy']) ? $data['retryPolicy'] : null; + $this->container['securityPolicy'] = isset($data['securityPolicy']) ? $data['securityPolicy'] : null; + $this->container['createdOn'] = isset($data['createdOn']) ? $data['createdOn'] : null; + $this->container['updatedOn'] = isset($data['updatedOn']) ? $data['updatedOn'] : null; + $this->container['notificationScope'] = isset($data['notificationScope']) ? $data['notificationScope'] : 'DESCENDANTS'; } /** @@ -190,127 +232,274 @@ public function valid() /** - * Gets totalCount - * @return int + * Gets webhookId + * @return string + */ + public function getWebhookId() + { + return $this->container['webhookId']; + } + + /** + * Sets webhookId + * @param string $webhookId Webhook Id. This is generated by the server. + * @return $this + */ + public function setWebhookId($webhookId) + { + $this->container['webhookId'] = $webhookId; + + return $this; + } + + /** + * Gets organizationId + * @return string + */ + public function getOrganizationId() + { + return $this->container['organizationId']; + } + + /** + * Sets organizationId + * @param string $organizationId Organization ID. + * @return $this + */ + public function setOrganizationId($organizationId) + { + $this->container['organizationId'] = $organizationId; + + return $this; + } + + /** + * Gets products + * @return \CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[] + */ + public function getProducts() + { + return $this->container['products']; + } + + /** + * Sets products + * @param \CyberSource\Model\Notificationsubscriptionsv2webhooksProducts[] $products + * @return $this + */ + public function setProducts($products) + { + $this->container['products'] = $products; + + return $this; + } + + /** + * Gets webhookUrl + * @return string + */ + public function getWebhookUrl() + { + return $this->container['webhookUrl']; + } + + /** + * Sets webhookUrl + * @param string $webhookUrl The client's endpoint (URL) to receive webhooks. + * @return $this + */ + public function setWebhookUrl($webhookUrl) + { + $this->container['webhookUrl'] = $webhookUrl; + + return $this; + } + + /** + * Gets healthCheckUrl + * @return string + */ + public function getHealthCheckUrl() + { + return $this->container['healthCheckUrl']; + } + + /** + * Sets healthCheckUrl + * @param string $healthCheckUrl The client's health check endpoint (URL). + * @return $this + */ + public function setHealthCheckUrl($healthCheckUrl) + { + $this->container['healthCheckUrl'] = $healthCheckUrl; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Webhook status. + * @return $this */ - public function getTotalCount() + public function setStatus($status) { - return $this->container['totalCount']; + $this->container['status'] = $status; + + return $this; } /** - * Sets totalCount - * @param int $totalCount Total number of results. + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name Client friendly webhook name. * @return $this */ - public function setTotalCount($totalCount) + public function setName($name) { - $this->container['totalCount'] = $totalCount; + $this->container['name'] = $name; return $this; } /** - * Gets offset - * @return int + * Gets description + * @return string */ - public function getOffset() + public function getDescription() { - return $this->container['offset']; + return $this->container['description']; } /** - * Sets offset - * @param int $offset Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. + * Sets description + * @param string $description Client friendly webhook description. * @return $this */ - public function setOffset($offset) + public function setDescription($description) { - $this->container['offset'] = $offset; + $this->container['description'] = $description; return $this; } /** - * Gets limit - * @return int + * Gets retryPolicy + * @return \CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy */ - public function getLimit() + public function getRetryPolicy() { - return $this->container['limit']; + return $this->container['retryPolicy']; } /** - * Sets limit - * @param int $limit Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. + * Sets retryPolicy + * @param \CyberSource\Model\Notificationsubscriptionsv2webhooksRetryPolicy $retryPolicy * @return $this */ - public function setLimit($limit) + public function setRetryPolicy($retryPolicy) { - $this->container['limit'] = $limit; + $this->container['retryPolicy'] = $retryPolicy; return $this; } /** - * Gets sort + * Gets securityPolicy + * @return \CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy + */ + public function getSecurityPolicy() + { + return $this->container['securityPolicy']; + } + + /** + * Sets securityPolicy + * @param \CyberSource\Model\Notificationsubscriptionsv2webhooksSecurityPolicy $securityPolicy + * @return $this + */ + public function setSecurityPolicy($securityPolicy) + { + $this->container['securityPolicy'] = $securityPolicy; + + return $this; + } + + /** + * Gets createdOn * @return string */ - public function getSort() + public function getCreatedOn() { - return $this->container['sort']; + return $this->container['createdOn']; } /** - * Sets sort - * @param string $sort A comma separated list of the following form: `submitTimeUtc:desc` + * Sets createdOn + * @param string $createdOn Date on which webhook was created/registered. * @return $this */ - public function setSort($sort) + public function setCreatedOn($createdOn) { - $this->container['sort'] = $sort; + $this->container['createdOn'] = $createdOn; return $this; } /** - * Gets count - * @return int + * Gets updatedOn + * @return string */ - public function getCount() + public function getUpdatedOn() { - return $this->container['count']; + return $this->container['updatedOn']; } /** - * Sets count - * @param int $count Results for this page, this could be below the limit. + * Sets updatedOn + * @param string $updatedOn Date on which webhook was most recently updated. * @return $this */ - public function setCount($count) + public function setUpdatedOn($updatedOn) { - $this->container['count'] = $count; + $this->container['updatedOn'] = $updatedOn; return $this; } /** - * Gets devices - * @return \CyberSource\Model\InlineResponse2007Devices[] + * Gets notificationScope + * @return string */ - public function getDevices() + public function getNotificationScope() { - return $this->container['devices']; + return $this->container['notificationScope']; } /** - * Sets devices - * @param \CyberSource\Model\InlineResponse2007Devices[] $devices A collection of devices + * Sets notificationScope + * @param string $notificationScope The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. This field is optional. Possible values: - SELF - DESCENDANTS * @return $this */ - public function setDevices($devices) + public function setNotificationScope($notificationScope) { - $this->container['devices'] = $devices; + $this->container['notificationScope'] = $notificationScope; return $this; } diff --git a/lib/Model/InlineResponse2008.php b/lib/Model/InlineResponse2008.php index 448c0bc60..b7ea7d553 100644 --- a/lib/Model/InlineResponse2008.php +++ b/lib/Model/InlineResponse2008.php @@ -53,8 +53,12 @@ class InlineResponse2008 implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'status' => 'string', - 'devices' => '\CyberSource\Model\Dmsv3devicesdeassociateDevices[]' + 'totalCount' => 'int', + 'offset' => 'int', + 'limit' => 'int', + 'sort' => 'string', + 'count' => 'int', + 'devices' => '\CyberSource\Model\InlineResponse2008Devices[]' ]; /** @@ -62,7 +66,11 @@ class InlineResponse2008 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'status' => null, + 'totalCount' => null, + 'offset' => null, + 'limit' => null, + 'sort' => null, + 'count' => null, 'devices' => null ]; @@ -81,7 +89,11 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'status' => 'status', + 'totalCount' => 'totalCount', + 'offset' => 'offset', + 'limit' => 'limit', + 'sort' => 'sort', + 'count' => 'count', 'devices' => 'devices' ]; @@ -91,7 +103,11 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'status' => 'setStatus', + 'totalCount' => 'setTotalCount', + 'offset' => 'setOffset', + 'limit' => 'setLimit', + 'sort' => 'setSort', + 'count' => 'setCount', 'devices' => 'setDevices' ]; @@ -101,7 +117,11 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'status' => 'getStatus', + 'totalCount' => 'getTotalCount', + 'offset' => 'getOffset', + 'limit' => 'getLimit', + 'sort' => 'getSort', + 'count' => 'getCount', 'devices' => 'getDevices' ]; @@ -136,7 +156,11 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['totalCount'] = isset($data['totalCount']) ? $data['totalCount'] : null; + $this->container['offset'] = isset($data['offset']) ? $data['offset'] : null; + $this->container['limit'] = isset($data['limit']) ? $data['limit'] : null; + $this->container['sort'] = isset($data['sort']) ? $data['sort'] : null; + $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['devices'] = isset($data['devices']) ? $data['devices'] : null; } @@ -166,29 +190,113 @@ public function valid() /** - * Gets status + * Gets totalCount + * @return int + */ + public function getTotalCount() + { + return $this->container['totalCount']; + } + + /** + * Sets totalCount + * @param int $totalCount Total number of results. + * @return $this + */ + public function setTotalCount($totalCount) + { + $this->container['totalCount'] = $totalCount; + + return $this; + } + + /** + * Gets offset + * @return int + */ + public function getOffset() + { + return $this->container['offset']; + } + + /** + * Sets offset + * @param int $offset Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. + * @return $this + */ + public function setOffset($offset) + { + $this->container['offset'] = $offset; + + return $this; + } + + /** + * Gets limit + * @return int + */ + public function getLimit() + { + return $this->container['limit']; + } + + /** + * Sets limit + * @param int $limit Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. + * @return $this + */ + public function setLimit($limit) + { + $this->container['limit'] = $limit; + + return $this; + } + + /** + * Gets sort * @return string */ - public function getStatus() + public function getSort() + { + return $this->container['sort']; + } + + /** + * Sets sort + * @param string $sort A comma separated list of the following form: `submitTimeUtc:desc` + * @return $this + */ + public function setSort($sort) + { + $this->container['sort'] = $sort; + + return $this; + } + + /** + * Gets count + * @return int + */ + public function getCount() { - return $this->container['status']; + return $this->container['count']; } /** - * Sets status - * @param string $status Possible values: - OK + * Sets count + * @param int $count Results for this page, this could be below the limit. * @return $this */ - public function setStatus($status) + public function setCount($count) { - $this->container['status'] = $status; + $this->container['count'] = $count; return $this; } /** * Gets devices - * @return \CyberSource\Model\Dmsv3devicesdeassociateDevices[] + * @return \CyberSource\Model\InlineResponse2008Devices[] */ public function getDevices() { @@ -197,7 +305,7 @@ public function getDevices() /** * Sets devices - * @param \CyberSource\Model\Dmsv3devicesdeassociateDevices[] $devices + * @param \CyberSource\Model\InlineResponse2008Devices[] $devices A collection of devices * @return $this */ public function setDevices($devices) diff --git a/lib/Model/InlineResponse2007Devices.php b/lib/Model/InlineResponse2008Devices.php similarity index 98% rename from lib/Model/InlineResponse2007Devices.php rename to lib/Model/InlineResponse2008Devices.php index c074077ca..a5cca3aec 100644 --- a/lib/Model/InlineResponse2007Devices.php +++ b/lib/Model/InlineResponse2008Devices.php @@ -1,6 +1,6 @@ 'int', - 'offset' => 'int', - 'limit' => 'int', - 'sort' => 'string', - 'count' => 'int', - 'devices' => '\CyberSource\Model\InlineResponse2009Devices[]' + 'status' => 'string', + 'devices' => '\CyberSource\Model\Dmsv3devicesdeassociateDevices[]' ]; /** @@ -66,11 +62,7 @@ class InlineResponse2009 implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'totalCount' => null, - 'offset' => null, - 'limit' => null, - 'sort' => null, - 'count' => null, + 'status' => null, 'devices' => null ]; @@ -89,11 +81,7 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'totalCount' => 'totalCount', - 'offset' => 'offset', - 'limit' => 'limit', - 'sort' => 'sort', - 'count' => 'count', + 'status' => 'status', 'devices' => 'devices' ]; @@ -103,11 +91,7 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'totalCount' => 'setTotalCount', - 'offset' => 'setOffset', - 'limit' => 'setLimit', - 'sort' => 'setSort', - 'count' => 'setCount', + 'status' => 'setStatus', 'devices' => 'setDevices' ]; @@ -117,11 +101,7 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'totalCount' => 'getTotalCount', - 'offset' => 'getOffset', - 'limit' => 'getLimit', - 'sort' => 'getSort', - 'count' => 'getCount', + 'status' => 'getStatus', 'devices' => 'getDevices' ]; @@ -156,11 +136,7 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['totalCount'] = isset($data['totalCount']) ? $data['totalCount'] : null; - $this->container['offset'] = isset($data['offset']) ? $data['offset'] : null; - $this->container['limit'] = isset($data['limit']) ? $data['limit'] : null; - $this->container['sort'] = isset($data['sort']) ? $data['sort'] : null; - $this->container['count'] = isset($data['count']) ? $data['count'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['devices'] = isset($data['devices']) ? $data['devices'] : null; } @@ -190,113 +166,29 @@ public function valid() /** - * Gets totalCount - * @return int - */ - public function getTotalCount() - { - return $this->container['totalCount']; - } - - /** - * Sets totalCount - * @param int $totalCount Total number of results. - * @return $this - */ - public function setTotalCount($totalCount) - { - $this->container['totalCount'] = $totalCount; - - return $this; - } - - /** - * Gets offset - * @return int - */ - public function getOffset() - { - return $this->container['offset']; - } - - /** - * Sets offset - * @param int $offset Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. - * @return $this - */ - public function setOffset($offset) - { - $this->container['offset'] = $offset; - - return $this; - } - - /** - * Gets limit - * @return int - */ - public function getLimit() - { - return $this->container['limit']; - } - - /** - * Sets limit - * @param int $limit Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. - * @return $this - */ - public function setLimit($limit) - { - $this->container['limit'] = $limit; - - return $this; - } - - /** - * Gets sort + * Gets status * @return string */ - public function getSort() - { - return $this->container['sort']; - } - - /** - * Sets sort - * @param string $sort A comma separated list of the following form: `terminalCreationDate:desc or serialNumber or terminalUpdationDate` - * @return $this - */ - public function setSort($sort) - { - $this->container['sort'] = $sort; - - return $this; - } - - /** - * Gets count - * @return int - */ - public function getCount() + public function getStatus() { - return $this->container['count']; + return $this->container['status']; } /** - * Sets count - * @param int $count Results for this page, this could be below the limit. + * Sets status + * @param string $status Possible values: - OK * @return $this */ - public function setCount($count) + public function setStatus($status) { - $this->container['count'] = $count; + $this->container['status'] = $status; return $this; } /** * Gets devices - * @return \CyberSource\Model\InlineResponse2009Devices[] + * @return \CyberSource\Model\Dmsv3devicesdeassociateDevices[] */ public function getDevices() { @@ -305,7 +197,7 @@ public function getDevices() /** * Sets devices - * @param \CyberSource\Model\InlineResponse2009Devices[] $devices A collection of devices + * @param \CyberSource\Model\Dmsv3devicesdeassociateDevices[] $devices * @return $this */ public function setDevices($devices) diff --git a/lib/Model/InlineResponse20010Links.php b/lib/Model/InlineResponse200Details.php similarity index 79% rename from lib/Model/InlineResponse20010Links.php rename to lib/Model/InlineResponse200Details.php index 3f39d0ac2..042154f57 100644 --- a/lib/Model/InlineResponse20010Links.php +++ b/lib/Model/InlineResponse200Details.php @@ -1,6 +1,6 @@ 'string', - 'href' => 'string' + 'name' => 'string', + 'location' => 'string' ]; /** @@ -62,8 +62,8 @@ class InlineResponse20010Links implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'rel' => null, - 'href' => null + 'name' => null, + 'location' => null ]; public static function swaggerTypes() @@ -81,8 +81,8 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'rel' => 'rel', - 'href' => 'href' + 'name' => 'name', + 'location' => 'location' ]; @@ -91,8 +91,8 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'rel' => 'setRel', - 'href' => 'setHref' + 'name' => 'setName', + 'location' => 'setLocation' ]; @@ -101,8 +101,8 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'rel' => 'getRel', - 'href' => 'getHref' + 'name' => 'getName', + 'location' => 'getLocation' ]; public static function attributeMap() @@ -136,8 +136,8 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['rel'] = isset($data['rel']) ? $data['rel'] : null; - $this->container['href'] = isset($data['href']) ? $data['href'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['location'] = isset($data['location']) ? $data['location'] : null; } /** @@ -166,43 +166,43 @@ public function valid() /** - * Gets rel + * Gets name * @return string */ - public function getRel() + public function getName() { - return $this->container['rel']; + return $this->container['name']; } /** - * Sets rel - * @param string $rel Valid Values: * self * first * last * prev * next + * Sets name + * @param string $name The name of the field that caused the error. * @return $this */ - public function setRel($rel) + public function setName($name) { - $this->container['rel'] = $rel; + $this->container['name'] = $name; return $this; } /** - * Gets href + * Gets location * @return string */ - public function getHref() + public function getLocation() { - return $this->container['href']; + return $this->container['location']; } /** - * Sets href - * @param string $href + * Sets location + * @param string $location The location of the field that caused the error. * @return $this */ - public function setHref($href) + public function setLocation($location) { - $this->container['href'] = $href; + $this->container['location'] = $location; return $this; } diff --git a/lib/Model/InlineResponse200Errors.php b/lib/Model/InlineResponse200Errors.php new file mode 100644 index 000000000..4460456d4 --- /dev/null +++ b/lib/Model/InlineResponse200Errors.php @@ -0,0 +1,299 @@ + 'string', + 'message' => 'string', + 'details' => '\CyberSource\Model\InlineResponse200Details[]' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'type' => null, + 'message' => null, + 'details' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'type' => 'type', + 'message' => 'message', + 'details' => 'details' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'type' => 'setType', + 'message' => 'setMessage', + 'details' => 'setDetails' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'type' => 'getType', + 'message' => 'getMessage', + 'details' => 'getDetails' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['type'] = isset($data['type']) ? $data['type'] : null; + $this->container['message'] = isset($data['message']) ? $data['message'] : null; + $this->container['details'] = isset($data['details']) ? $data['details'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets type + * @return string + */ + public function getType() + { + return $this->container['type']; + } + + /** + * Sets type + * @param string $type The type of error. Possible Values: - invalidHeaders - missingHeaders - invalidFields - missingFields - unsupportedPaymentMethodModification - invalidCombination - forbidden - notFound - instrumentIdentifierDeletionError - tokenIdConflict - conflict - notAvailable - serverError - notAttempted A \"notAttempted\" error type is returned when the request cannot be processed because it depends on the existence of another token that does not exist. For example, creating a shipping address token is not attempted if the required customer token is missing. + * @return $this + */ + public function setType($type) + { + $this->container['type'] = $type; + + return $this; + } + + /** + * Gets message + * @return string + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * @param string $message The detailed message related to the type. + * @return $this + */ + public function setMessage($message) + { + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets details + * @return \CyberSource\Model\InlineResponse200Details[] + */ + public function getDetails() + { + return $this->container['details']; + } + + /** + * Sets details + * @param \CyberSource\Model\InlineResponse200Details[] $details + * @return $this + */ + public function setDetails($details) + { + $this->container['details'] = $details; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/InlineResponse200Responses.php b/lib/Model/InlineResponse200Responses.php new file mode 100644 index 000000000..5bbea087e --- /dev/null +++ b/lib/Model/InlineResponse200Responses.php @@ -0,0 +1,326 @@ + 'string', + 'httpStatus' => 'int', + 'id' => 'string', + 'errors' => '\CyberSource\Model\InlineResponse200Errors[]' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'resource' => null, + 'httpStatus' => 'int32', + 'id' => null, + 'errors' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'resource' => 'resource', + 'httpStatus' => 'httpStatus', + 'id' => 'id', + 'errors' => 'errors' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'resource' => 'setResource', + 'httpStatus' => 'setHttpStatus', + 'id' => 'setId', + 'errors' => 'setErrors' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'resource' => 'getResource', + 'httpStatus' => 'getHttpStatus', + 'id' => 'getId', + 'errors' => 'getErrors' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['resource'] = isset($data['resource']) ? $data['resource'] : null; + $this->container['httpStatus'] = isset($data['httpStatus']) ? $data['httpStatus'] : null; + $this->container['id'] = isset($data['id']) ? $data['id'] : null; + $this->container['errors'] = isset($data['errors']) ? $data['errors'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets resource + * @return string + */ + public function getResource() + { + return $this->container['resource']; + } + + /** + * Sets resource + * @param string $resource TMS token type associated with the response. Possible Values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress - tokenizedCard + * @return $this + */ + public function setResource($resource) + { + $this->container['resource'] = $resource; + + return $this; + } + + /** + * Gets httpStatus + * @return int + */ + public function getHttpStatus() + { + return $this->container['httpStatus']; + } + + /** + * Sets httpStatus + * @param int $httpStatus Http status associated with the response. + * @return $this + */ + public function setHttpStatus($httpStatus) + { + $this->container['httpStatus'] = $httpStatus; + + return $this; + } + + /** + * Gets id + * @return string + */ + public function getId() + { + return $this->container['id']; + } + + /** + * Sets id + * @param string $id TMS token id associated with the response. + * @return $this + */ + public function setId($id) + { + $this->container['id'] = $id; + + return $this; + } + + /** + * Gets errors + * @return \CyberSource\Model\InlineResponse200Errors[] + */ + public function getErrors() + { + return $this->container['errors']; + } + + /** + * Sets errors + * @param \CyberSource\Model\InlineResponse200Errors[] $errors + * @return $this + */ + public function setErrors($errors) + { + $this->container['errors'] = $errors; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/InlineResponse2013SetupsPayments.php b/lib/Model/InlineResponse2013SetupsPayments.php index 25ea93ad9..5077dac9f 100644 --- a/lib/Model/InlineResponse2013SetupsPayments.php +++ b/lib/Model/InlineResponse2013SetupsPayments.php @@ -71,7 +71,8 @@ class InlineResponse2013SetupsPayments implements ArrayAccess 'payByLink' => '\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments', 'unifiedCheckout' => '\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments', 'receivablesManager' => '\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments', - 'serviceFee' => '\CyberSource\Model\InlineResponse2013SetupsPaymentsCardProcessing' + 'serviceFee' => '\CyberSource\Model\InlineResponse2013SetupsPaymentsCardProcessing', + 'batchUpload' => '\CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments' ]; /** @@ -97,7 +98,8 @@ class InlineResponse2013SetupsPayments implements ArrayAccess 'payByLink' => null, 'unifiedCheckout' => null, 'receivablesManager' => null, - 'serviceFee' => null + 'serviceFee' => null, + 'batchUpload' => null ]; public static function swaggerTypes() @@ -133,7 +135,8 @@ public static function swaggerFormats() 'payByLink' => 'payByLink', 'unifiedCheckout' => 'unifiedCheckout', 'receivablesManager' => 'receivablesManager', - 'serviceFee' => 'serviceFee' + 'serviceFee' => 'serviceFee', + 'batchUpload' => 'batchUpload' ]; @@ -160,7 +163,8 @@ public static function swaggerFormats() 'payByLink' => 'setPayByLink', 'unifiedCheckout' => 'setUnifiedCheckout', 'receivablesManager' => 'setReceivablesManager', - 'serviceFee' => 'setServiceFee' + 'serviceFee' => 'setServiceFee', + 'batchUpload' => 'setBatchUpload' ]; @@ -187,7 +191,8 @@ public static function swaggerFormats() 'payByLink' => 'getPayByLink', 'unifiedCheckout' => 'getUnifiedCheckout', 'receivablesManager' => 'getReceivablesManager', - 'serviceFee' => 'getServiceFee' + 'serviceFee' => 'getServiceFee', + 'batchUpload' => 'getBatchUpload' ]; public static function attributeMap() @@ -240,6 +245,7 @@ public function __construct(array $data = null) $this->container['unifiedCheckout'] = isset($data['unifiedCheckout']) ? $data['unifiedCheckout'] : null; $this->container['receivablesManager'] = isset($data['receivablesManager']) ? $data['receivablesManager'] : null; $this->container['serviceFee'] = isset($data['serviceFee']) ? $data['serviceFee'] : null; + $this->container['batchUpload'] = isset($data['batchUpload']) ? $data['batchUpload'] : null; } /** @@ -665,6 +671,27 @@ public function setServiceFee($serviceFee) return $this; } + + /** + * Gets batchUpload + * @return \CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments + */ + public function getBatchUpload() + { + return $this->container['batchUpload']; + } + + /** + * Sets batchUpload + * @param \CyberSource\Model\InlineResponse2013SetupsPaymentsDigitalPayments $batchUpload + * @return $this + */ + public function setBatchUpload($batchUpload) + { + $this->container['batchUpload'] = $batchUpload; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/PatchCustomerPaymentInstrumentRequest.php b/lib/Model/PatchCustomerPaymentInstrumentRequest.php index c8c69c19b..0be248072 100644 --- a/lib/Model/PatchCustomerPaymentInstrumentRequest.php +++ b/lib/Model/PatchCustomerPaymentInstrumentRequest.php @@ -53,21 +53,21 @@ class PatchCustomerPaymentInstrumentRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks', 'id' => 'string', 'object' => 'string', 'default' => 'bool', 'state' => 'string', 'type' => 'string', - 'bankAccount' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', - 'card' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'bankAccount' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount', + 'card' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'processingInformation' => '\CyberSource\Model\TmsPaymentInstrumentProcessingInfo', - 'merchantInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', - 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded' + 'merchantInformation' => '\CyberSource\Model\TmsMerchantInformation', + 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded' ]; /** @@ -245,7 +245,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks */ public function getLinks() { @@ -254,7 +254,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks $links * @return $this */ public function setLinks($links) @@ -371,7 +371,7 @@ public function setType($type) /** * Gets bankAccount - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount */ public function getBankAccount() { @@ -380,7 +380,7 @@ public function getBankAccount() /** * Sets bankAccount - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount * @return $this */ public function setBankAccount($bankAccount) @@ -392,7 +392,7 @@ public function setBankAccount($bankAccount) /** * Gets card - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard */ public function getCard() { @@ -401,7 +401,7 @@ public function getCard() /** * Sets card - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard $card + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard $card * @return $this */ public function setCard($card) @@ -413,7 +413,7 @@ public function setCard($card) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation */ public function getBuyerInformation() { @@ -422,7 +422,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -434,7 +434,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -443,7 +443,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) @@ -476,7 +476,7 @@ public function setProcessingInformation($processingInformation) /** * Gets merchantInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + * @return \CyberSource\Model\TmsMerchantInformation */ public function getMerchantInformation() { @@ -485,7 +485,7 @@ public function getMerchantInformation() /** * Sets merchantInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation $merchantInformation + * @param \CyberSource\Model\TmsMerchantInformation $merchantInformation * @return $this */ public function setMerchantInformation($merchantInformation) @@ -497,7 +497,7 @@ public function setMerchantInformation($merchantInformation) /** * Gets instrumentIdentifier - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier */ public function getInstrumentIdentifier() { @@ -506,7 +506,7 @@ public function getInstrumentIdentifier() /** * Sets instrumentIdentifier - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier * @return $this */ public function setInstrumentIdentifier($instrumentIdentifier) @@ -518,7 +518,7 @@ public function setInstrumentIdentifier($instrumentIdentifier) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata */ public function getMetadata() { @@ -527,7 +527,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -539,7 +539,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded */ public function getEmbedded() { @@ -548,7 +548,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/PatchCustomerRequest.php b/lib/Model/PatchCustomerRequest.php index 89733d918..94e426d6e 100644 --- a/lib/Model/PatchCustomerRequest.php +++ b/lib/Model/PatchCustomerRequest.php @@ -53,16 +53,16 @@ class PatchCustomerRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks', 'id' => 'string', - 'objectInformation' => '\CyberSource\Model\Tmsv2customersObjectInformation', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersBuyerInformation', - 'clientReferenceInformation' => '\CyberSource\Model\Tmsv2customersClientReferenceInformation', - 'merchantDefinedInformation' => '\CyberSource\Model\Tmsv2customersMerchantDefinedInformation[]', - 'defaultPaymentInstrument' => '\CyberSource\Model\Tmsv2customersDefaultPaymentInstrument', - 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2customersDefaultShippingAddress', - 'metadata' => '\CyberSource\Model\Tmsv2customersMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbedded' + 'objectInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation', + 'clientReferenceInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation', + 'merchantDefinedInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[]', + 'defaultPaymentInstrument' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument', + 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded' ]; /** @@ -215,7 +215,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks */ public function getLinks() { @@ -224,7 +224,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks $links * @return $this */ public function setLinks($links) @@ -257,7 +257,7 @@ public function setId($id) /** * Gets objectInformation - * @return \CyberSource\Model\Tmsv2customersObjectInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation */ public function getObjectInformation() { @@ -266,7 +266,7 @@ public function getObjectInformation() /** * Sets objectInformation - * @param \CyberSource\Model\Tmsv2customersObjectInformation $objectInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation $objectInformation * @return $this */ public function setObjectInformation($objectInformation) @@ -278,7 +278,7 @@ public function setObjectInformation($objectInformation) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation */ public function getBuyerInformation() { @@ -287,7 +287,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -299,7 +299,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets clientReferenceInformation - * @return \CyberSource\Model\Tmsv2customersClientReferenceInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation */ public function getClientReferenceInformation() { @@ -308,7 +308,7 @@ public function getClientReferenceInformation() /** * Sets clientReferenceInformation - * @param \CyberSource\Model\Tmsv2customersClientReferenceInformation $clientReferenceInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation $clientReferenceInformation * @return $this */ public function setClientReferenceInformation($clientReferenceInformation) @@ -320,7 +320,7 @@ public function setClientReferenceInformation($clientReferenceInformation) /** * Gets merchantDefinedInformation - * @return \CyberSource\Model\Tmsv2customersMerchantDefinedInformation[] + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[] */ public function getMerchantDefinedInformation() { @@ -329,7 +329,7 @@ public function getMerchantDefinedInformation() /** * Sets merchantDefinedInformation - * @param \CyberSource\Model\Tmsv2customersMerchantDefinedInformation[] $merchantDefinedInformation Object containing the custom data that the merchant defines. + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[] $merchantDefinedInformation Object containing the custom data that the merchant defines. * @return $this */ public function setMerchantDefinedInformation($merchantDefinedInformation) @@ -341,7 +341,7 @@ public function setMerchantDefinedInformation($merchantDefinedInformation) /** * Gets defaultPaymentInstrument - * @return \CyberSource\Model\Tmsv2customersDefaultPaymentInstrument + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument */ public function getDefaultPaymentInstrument() { @@ -350,7 +350,7 @@ public function getDefaultPaymentInstrument() /** * Sets defaultPaymentInstrument - * @param \CyberSource\Model\Tmsv2customersDefaultPaymentInstrument $defaultPaymentInstrument + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument $defaultPaymentInstrument * @return $this */ public function setDefaultPaymentInstrument($defaultPaymentInstrument) @@ -362,7 +362,7 @@ public function setDefaultPaymentInstrument($defaultPaymentInstrument) /** * Gets defaultShippingAddress - * @return \CyberSource\Model\Tmsv2customersDefaultShippingAddress + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress */ public function getDefaultShippingAddress() { @@ -371,7 +371,7 @@ public function getDefaultShippingAddress() /** * Sets defaultShippingAddress - * @param \CyberSource\Model\Tmsv2customersDefaultShippingAddress $defaultShippingAddress + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress $defaultShippingAddress * @return $this */ public function setDefaultShippingAddress($defaultShippingAddress) @@ -383,7 +383,7 @@ public function setDefaultShippingAddress($defaultShippingAddress) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata */ public function getMetadata() { @@ -392,7 +392,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -404,7 +404,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded */ public function getEmbedded() { @@ -413,7 +413,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/PatchCustomerShippingAddressRequest.php b/lib/Model/PatchCustomerShippingAddressRequest.php index 97c725e26..8270b8d8c 100644 --- a/lib/Model/PatchCustomerShippingAddressRequest.php +++ b/lib/Model/PatchCustomerShippingAddressRequest.php @@ -53,11 +53,11 @@ class PatchCustomerShippingAddressRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks', 'id' => 'string', 'default' => 'bool', - 'shipTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata' + 'shipTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata' ]; /** @@ -185,7 +185,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks */ public function getLinks() { @@ -194,7 +194,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks $links * @return $this */ public function setLinks($links) @@ -248,7 +248,7 @@ public function setDefault($default) /** * Gets shipTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo */ public function getShipTo() { @@ -257,7 +257,7 @@ public function getShipTo() /** * Sets shipTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo $shipTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo $shipTo * @return $this */ public function setShipTo($shipTo) @@ -269,7 +269,7 @@ public function setShipTo($shipTo) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata */ public function getMetadata() { @@ -278,7 +278,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata $metadata * @return $this */ public function setMetadata($metadata) diff --git a/lib/Model/PatchPaymentInstrumentRequest.php b/lib/Model/PatchPaymentInstrumentRequest.php index 1fac8354b..f19cc8f62 100644 --- a/lib/Model/PatchPaymentInstrumentRequest.php +++ b/lib/Model/PatchPaymentInstrumentRequest.php @@ -53,21 +53,21 @@ class PatchPaymentInstrumentRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks', 'id' => 'string', 'object' => 'string', 'default' => 'bool', 'state' => 'string', 'type' => 'string', - 'bankAccount' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', - 'card' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'bankAccount' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount', + 'card' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'processingInformation' => '\CyberSource\Model\TmsPaymentInstrumentProcessingInfo', - 'merchantInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', - 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded' + 'merchantInformation' => '\CyberSource\Model\TmsMerchantInformation', + 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded' ]; /** @@ -245,7 +245,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks */ public function getLinks() { @@ -254,7 +254,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks $links * @return $this */ public function setLinks($links) @@ -371,7 +371,7 @@ public function setType($type) /** * Gets bankAccount - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount */ public function getBankAccount() { @@ -380,7 +380,7 @@ public function getBankAccount() /** * Sets bankAccount - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount * @return $this */ public function setBankAccount($bankAccount) @@ -392,7 +392,7 @@ public function setBankAccount($bankAccount) /** * Gets card - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard */ public function getCard() { @@ -401,7 +401,7 @@ public function getCard() /** * Sets card - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard $card + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard $card * @return $this */ public function setCard($card) @@ -413,7 +413,7 @@ public function setCard($card) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation */ public function getBuyerInformation() { @@ -422,7 +422,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -434,7 +434,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -443,7 +443,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) @@ -476,7 +476,7 @@ public function setProcessingInformation($processingInformation) /** * Gets merchantInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + * @return \CyberSource\Model\TmsMerchantInformation */ public function getMerchantInformation() { @@ -485,7 +485,7 @@ public function getMerchantInformation() /** * Sets merchantInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation $merchantInformation + * @param \CyberSource\Model\TmsMerchantInformation $merchantInformation * @return $this */ public function setMerchantInformation($merchantInformation) @@ -497,7 +497,7 @@ public function setMerchantInformation($merchantInformation) /** * Gets instrumentIdentifier - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier */ public function getInstrumentIdentifier() { @@ -506,7 +506,7 @@ public function getInstrumentIdentifier() /** * Sets instrumentIdentifier - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier * @return $this */ public function setInstrumentIdentifier($instrumentIdentifier) @@ -518,7 +518,7 @@ public function setInstrumentIdentifier($instrumentIdentifier) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata */ public function getMetadata() { @@ -527,7 +527,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -539,7 +539,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded */ public function getEmbedded() { @@ -548,7 +548,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.php b/lib/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.php index 91a163b2c..a2564898b 100644 --- a/lib/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.php +++ b/lib/Model/PaymentInstrumentList1EmbeddedPaymentInstruments.php @@ -53,20 +53,20 @@ class PaymentInstrumentList1EmbeddedPaymentInstruments implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks', 'id' => 'string', 'object' => 'string', 'default' => 'bool', 'state' => 'string', 'type' => 'string', - 'bankAccount' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', - 'card' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'bankAccount' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount', + 'card' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'processingInformation' => '\CyberSource\Model\TmsPaymentInstrumentProcessingInfo', - 'merchantInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', - 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', + 'merchantInformation' => '\CyberSource\Model\TmsMerchantInformation', + 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata', 'embedded' => '\CyberSource\Model\PaymentInstrumentList1EmbeddedEmbedded' ]; @@ -245,7 +245,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks */ public function getLinks() { @@ -254,7 +254,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks $links * @return $this */ public function setLinks($links) @@ -371,7 +371,7 @@ public function setType($type) /** * Gets bankAccount - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount */ public function getBankAccount() { @@ -380,7 +380,7 @@ public function getBankAccount() /** * Sets bankAccount - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount * @return $this */ public function setBankAccount($bankAccount) @@ -392,7 +392,7 @@ public function setBankAccount($bankAccount) /** * Gets card - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard */ public function getCard() { @@ -401,7 +401,7 @@ public function getCard() /** * Sets card - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard $card + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard $card * @return $this */ public function setCard($card) @@ -413,7 +413,7 @@ public function setCard($card) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation */ public function getBuyerInformation() { @@ -422,7 +422,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -434,7 +434,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -443,7 +443,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) @@ -476,7 +476,7 @@ public function setProcessingInformation($processingInformation) /** * Gets merchantInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + * @return \CyberSource\Model\TmsMerchantInformation */ public function getMerchantInformation() { @@ -485,7 +485,7 @@ public function getMerchantInformation() /** * Sets merchantInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation $merchantInformation + * @param \CyberSource\Model\TmsMerchantInformation $merchantInformation * @return $this */ public function setMerchantInformation($merchantInformation) @@ -497,7 +497,7 @@ public function setMerchantInformation($merchantInformation) /** * Gets instrumentIdentifier - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier */ public function getInstrumentIdentifier() { @@ -506,7 +506,7 @@ public function getInstrumentIdentifier() /** * Sets instrumentIdentifier - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier * @return $this */ public function setInstrumentIdentifier($instrumentIdentifier) @@ -518,7 +518,7 @@ public function setInstrumentIdentifier($instrumentIdentifier) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata */ public function getMetadata() { @@ -527,7 +527,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata $metadata * @return $this */ public function setMetadata($metadata) diff --git a/lib/Model/PaymentInstrumentListEmbedded.php b/lib/Model/PaymentInstrumentListEmbedded.php index d8c27ce32..5264fdbf7 100644 --- a/lib/Model/PaymentInstrumentListEmbedded.php +++ b/lib/Model/PaymentInstrumentListEmbedded.php @@ -54,7 +54,7 @@ class PaymentInstrumentListEmbedded implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'paymentInstruments' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument[]' + 'paymentInstruments' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument[]' ]; /** @@ -162,7 +162,7 @@ public function valid() /** * Gets paymentInstruments - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument[] + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument[] */ public function getPaymentInstruments() { @@ -171,7 +171,7 @@ public function getPaymentInstruments() /** * Sets paymentInstruments - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument[] $paymentInstruments + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument[] $paymentInstruments * @return $this */ public function setPaymentInstruments($paymentInstruments) diff --git a/lib/Model/PaymentsProducts.php b/lib/Model/PaymentsProducts.php index 5e99af146..fe6b5568d 100644 --- a/lib/Model/PaymentsProducts.php +++ b/lib/Model/PaymentsProducts.php @@ -72,7 +72,8 @@ class PaymentsProducts implements ArrayAccess 'payByLink' => '\CyberSource\Model\PaymentsProductsTax', 'unifiedCheckout' => '\CyberSource\Model\PaymentsProductsUnifiedCheckout', 'receivablesManager' => '\CyberSource\Model\PaymentsProductsTax', - 'serviceFee' => '\CyberSource\Model\PaymentsProductsServiceFee' + 'serviceFee' => '\CyberSource\Model\PaymentsProductsServiceFee', + 'batchUpload' => '\CyberSource\Model\PaymentsProductsTax' ]; /** @@ -99,7 +100,8 @@ class PaymentsProducts implements ArrayAccess 'payByLink' => null, 'unifiedCheckout' => null, 'receivablesManager' => null, - 'serviceFee' => null + 'serviceFee' => null, + 'batchUpload' => null ]; public static function swaggerTypes() @@ -136,7 +138,8 @@ public static function swaggerFormats() 'payByLink' => 'payByLink', 'unifiedCheckout' => 'unifiedCheckout', 'receivablesManager' => 'receivablesManager', - 'serviceFee' => 'serviceFee' + 'serviceFee' => 'serviceFee', + 'batchUpload' => 'batchUpload' ]; @@ -164,7 +167,8 @@ public static function swaggerFormats() 'payByLink' => 'setPayByLink', 'unifiedCheckout' => 'setUnifiedCheckout', 'receivablesManager' => 'setReceivablesManager', - 'serviceFee' => 'setServiceFee' + 'serviceFee' => 'setServiceFee', + 'batchUpload' => 'setBatchUpload' ]; @@ -192,7 +196,8 @@ public static function swaggerFormats() 'payByLink' => 'getPayByLink', 'unifiedCheckout' => 'getUnifiedCheckout', 'receivablesManager' => 'getReceivablesManager', - 'serviceFee' => 'getServiceFee' + 'serviceFee' => 'getServiceFee', + 'batchUpload' => 'getBatchUpload' ]; public static function attributeMap() @@ -246,6 +251,7 @@ public function __construct(array $data = null) $this->container['unifiedCheckout'] = isset($data['unifiedCheckout']) ? $data['unifiedCheckout'] : null; $this->container['receivablesManager'] = isset($data['receivablesManager']) ? $data['receivablesManager'] : null; $this->container['serviceFee'] = isset($data['serviceFee']) ? $data['serviceFee'] : null; + $this->container['batchUpload'] = isset($data['batchUpload']) ? $data['batchUpload'] : null; } /** @@ -692,6 +698,27 @@ public function setServiceFee($serviceFee) return $this; } + + /** + * Gets batchUpload + * @return \CyberSource\Model\PaymentsProductsTax + */ + public function getBatchUpload() + { + return $this->container['batchUpload']; + } + + /** + * Sets batchUpload + * @param \CyberSource\Model\PaymentsProductsTax $batchUpload + * @return $this + */ + public function setBatchUpload($batchUpload) + { + $this->container['batchUpload'] = $batchUpload; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/PostCustomerPaymentInstrumentRequest.php b/lib/Model/PostCustomerPaymentInstrumentRequest.php index 6a60e04a7..0d81ce5b6 100644 --- a/lib/Model/PostCustomerPaymentInstrumentRequest.php +++ b/lib/Model/PostCustomerPaymentInstrumentRequest.php @@ -53,21 +53,21 @@ class PostCustomerPaymentInstrumentRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks', 'id' => 'string', 'object' => 'string', 'default' => 'bool', 'state' => 'string', 'type' => 'string', - 'bankAccount' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', - 'card' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'bankAccount' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount', + 'card' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'processingInformation' => '\CyberSource\Model\TmsPaymentInstrumentProcessingInfo', - 'merchantInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', - 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded' + 'merchantInformation' => '\CyberSource\Model\TmsMerchantInformation', + 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded' ]; /** @@ -245,7 +245,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks */ public function getLinks() { @@ -254,7 +254,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks $links * @return $this */ public function setLinks($links) @@ -371,7 +371,7 @@ public function setType($type) /** * Gets bankAccount - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount */ public function getBankAccount() { @@ -380,7 +380,7 @@ public function getBankAccount() /** * Sets bankAccount - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount * @return $this */ public function setBankAccount($bankAccount) @@ -392,7 +392,7 @@ public function setBankAccount($bankAccount) /** * Gets card - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard */ public function getCard() { @@ -401,7 +401,7 @@ public function getCard() /** * Sets card - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard $card + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard $card * @return $this */ public function setCard($card) @@ -413,7 +413,7 @@ public function setCard($card) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation */ public function getBuyerInformation() { @@ -422,7 +422,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -434,7 +434,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -443,7 +443,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) @@ -476,7 +476,7 @@ public function setProcessingInformation($processingInformation) /** * Gets merchantInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + * @return \CyberSource\Model\TmsMerchantInformation */ public function getMerchantInformation() { @@ -485,7 +485,7 @@ public function getMerchantInformation() /** * Sets merchantInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation $merchantInformation + * @param \CyberSource\Model\TmsMerchantInformation $merchantInformation * @return $this */ public function setMerchantInformation($merchantInformation) @@ -497,7 +497,7 @@ public function setMerchantInformation($merchantInformation) /** * Gets instrumentIdentifier - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier */ public function getInstrumentIdentifier() { @@ -506,7 +506,7 @@ public function getInstrumentIdentifier() /** * Sets instrumentIdentifier - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier * @return $this */ public function setInstrumentIdentifier($instrumentIdentifier) @@ -518,7 +518,7 @@ public function setInstrumentIdentifier($instrumentIdentifier) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata */ public function getMetadata() { @@ -527,7 +527,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -539,7 +539,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded */ public function getEmbedded() { @@ -548,7 +548,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/PostCustomerRequest.php b/lib/Model/PostCustomerRequest.php index 087d62b33..e5c462a93 100644 --- a/lib/Model/PostCustomerRequest.php +++ b/lib/Model/PostCustomerRequest.php @@ -53,16 +53,16 @@ class PostCustomerRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks', 'id' => 'string', - 'objectInformation' => '\CyberSource\Model\Tmsv2customersObjectInformation', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersBuyerInformation', - 'clientReferenceInformation' => '\CyberSource\Model\Tmsv2customersClientReferenceInformation', - 'merchantDefinedInformation' => '\CyberSource\Model\Tmsv2customersMerchantDefinedInformation[]', - 'defaultPaymentInstrument' => '\CyberSource\Model\Tmsv2customersDefaultPaymentInstrument', - 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2customersDefaultShippingAddress', - 'metadata' => '\CyberSource\Model\Tmsv2customersMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbedded' + 'objectInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation', + 'clientReferenceInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation', + 'merchantDefinedInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[]', + 'defaultPaymentInstrument' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument', + 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded' ]; /** @@ -215,7 +215,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks */ public function getLinks() { @@ -224,7 +224,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks $links * @return $this */ public function setLinks($links) @@ -257,7 +257,7 @@ public function setId($id) /** * Gets objectInformation - * @return \CyberSource\Model\Tmsv2customersObjectInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation */ public function getObjectInformation() { @@ -266,7 +266,7 @@ public function getObjectInformation() /** * Sets objectInformation - * @param \CyberSource\Model\Tmsv2customersObjectInformation $objectInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation $objectInformation * @return $this */ public function setObjectInformation($objectInformation) @@ -278,7 +278,7 @@ public function setObjectInformation($objectInformation) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation */ public function getBuyerInformation() { @@ -287,7 +287,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -299,7 +299,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets clientReferenceInformation - * @return \CyberSource\Model\Tmsv2customersClientReferenceInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation */ public function getClientReferenceInformation() { @@ -308,7 +308,7 @@ public function getClientReferenceInformation() /** * Sets clientReferenceInformation - * @param \CyberSource\Model\Tmsv2customersClientReferenceInformation $clientReferenceInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation $clientReferenceInformation * @return $this */ public function setClientReferenceInformation($clientReferenceInformation) @@ -320,7 +320,7 @@ public function setClientReferenceInformation($clientReferenceInformation) /** * Gets merchantDefinedInformation - * @return \CyberSource\Model\Tmsv2customersMerchantDefinedInformation[] + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[] */ public function getMerchantDefinedInformation() { @@ -329,7 +329,7 @@ public function getMerchantDefinedInformation() /** * Sets merchantDefinedInformation - * @param \CyberSource\Model\Tmsv2customersMerchantDefinedInformation[] $merchantDefinedInformation Object containing the custom data that the merchant defines. + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[] $merchantDefinedInformation Object containing the custom data that the merchant defines. * @return $this */ public function setMerchantDefinedInformation($merchantDefinedInformation) @@ -341,7 +341,7 @@ public function setMerchantDefinedInformation($merchantDefinedInformation) /** * Gets defaultPaymentInstrument - * @return \CyberSource\Model\Tmsv2customersDefaultPaymentInstrument + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument */ public function getDefaultPaymentInstrument() { @@ -350,7 +350,7 @@ public function getDefaultPaymentInstrument() /** * Sets defaultPaymentInstrument - * @param \CyberSource\Model\Tmsv2customersDefaultPaymentInstrument $defaultPaymentInstrument + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument $defaultPaymentInstrument * @return $this */ public function setDefaultPaymentInstrument($defaultPaymentInstrument) @@ -362,7 +362,7 @@ public function setDefaultPaymentInstrument($defaultPaymentInstrument) /** * Gets defaultShippingAddress - * @return \CyberSource\Model\Tmsv2customersDefaultShippingAddress + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress */ public function getDefaultShippingAddress() { @@ -371,7 +371,7 @@ public function getDefaultShippingAddress() /** * Sets defaultShippingAddress - * @param \CyberSource\Model\Tmsv2customersDefaultShippingAddress $defaultShippingAddress + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress $defaultShippingAddress * @return $this */ public function setDefaultShippingAddress($defaultShippingAddress) @@ -383,7 +383,7 @@ public function setDefaultShippingAddress($defaultShippingAddress) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata */ public function getMetadata() { @@ -392,7 +392,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -404,7 +404,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded */ public function getEmbedded() { @@ -413,7 +413,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/PostCustomerShippingAddressRequest.php b/lib/Model/PostCustomerShippingAddressRequest.php index 6288747fc..00d75e649 100644 --- a/lib/Model/PostCustomerShippingAddressRequest.php +++ b/lib/Model/PostCustomerShippingAddressRequest.php @@ -53,11 +53,11 @@ class PostCustomerShippingAddressRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks', 'id' => 'string', 'default' => 'bool', - 'shipTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata' + 'shipTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata' ]; /** @@ -185,7 +185,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks */ public function getLinks() { @@ -194,7 +194,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks $links * @return $this */ public function setLinks($links) @@ -248,7 +248,7 @@ public function setDefault($default) /** * Gets shipTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo */ public function getShipTo() { @@ -257,7 +257,7 @@ public function getShipTo() /** * Sets shipTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo $shipTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo $shipTo * @return $this */ public function setShipTo($shipTo) @@ -269,7 +269,7 @@ public function setShipTo($shipTo) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata */ public function getMetadata() { @@ -278,7 +278,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata $metadata * @return $this */ public function setMetadata($metadata) diff --git a/lib/Model/PostIssuerLifeCycleSimulationRequest.php b/lib/Model/PostIssuerLifeCycleSimulationRequest.php new file mode 100644 index 000000000..cb3a7d8a4 --- /dev/null +++ b/lib/Model/PostIssuerLifeCycleSimulationRequest.php @@ -0,0 +1,300 @@ + 'string', + 'card' => '\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'state' => null, + 'card' => null, + 'metadata' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'state' => 'state', + 'card' => 'card', + 'metadata' => 'metadata' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'state' => 'setState', + 'card' => 'setCard', + 'metadata' => 'setMetadata' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'state' => 'getState', + 'card' => 'getCard', + 'metadata' => 'getMetadata' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['state'] = isset($data['state']) ? $data['state'] : null; + $this->container['card'] = isset($data['card']) ? $data['card'] : null; + $this->container['metadata'] = isset($data['metadata']) ? $data['metadata'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets state + * @return string + */ + public function getState() + { + return $this->container['state']; + } + + /** + * Sets state + * @param string $state The new state of the Tokenized Card. Possible Values: - ACTIVE - SUSPENDED - DELETED + * @return $this + */ + public function setState($state) + { + $this->container['state'] = $state; + + return $this; + } + + /** + * Gets card + * @return \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard + */ + public function getCard() + { + return $this->container['card']; + } + + /** + * Sets card + * @param \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsCard $card + * @return $this + */ + public function setCard($card) + { + $this->container['card'] = $card; + + return $this; + } + + /** + * Gets metadata + * @return \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * @param \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata $metadata + * @return $this + */ + public function setMetadata($metadata) + { + $this->container['metadata'] = $metadata; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/PostPaymentInstrumentRequest.php b/lib/Model/PostPaymentInstrumentRequest.php index 2e2082aa6..1bebaba3f 100644 --- a/lib/Model/PostPaymentInstrumentRequest.php +++ b/lib/Model/PostPaymentInstrumentRequest.php @@ -53,21 +53,21 @@ class PostPaymentInstrumentRequest implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'links' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks', 'id' => 'string', 'object' => 'string', 'default' => 'bool', 'state' => 'string', 'type' => 'string', - 'bankAccount' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', - 'card' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'bankAccount' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount', + 'card' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'processingInformation' => '\CyberSource\Model\TmsPaymentInstrumentProcessingInfo', - 'merchantInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', - 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded' + 'merchantInformation' => '\CyberSource\Model\TmsMerchantInformation', + 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded' ]; /** @@ -245,7 +245,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks */ public function getLinks() { @@ -254,7 +254,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks $links * @return $this */ public function setLinks($links) @@ -371,7 +371,7 @@ public function setType($type) /** * Gets bankAccount - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount */ public function getBankAccount() { @@ -380,7 +380,7 @@ public function getBankAccount() /** * Sets bankAccount - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount * @return $this */ public function setBankAccount($bankAccount) @@ -392,7 +392,7 @@ public function setBankAccount($bankAccount) /** * Gets card - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard */ public function getCard() { @@ -401,7 +401,7 @@ public function getCard() /** * Sets card - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard $card + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard $card * @return $this */ public function setCard($card) @@ -413,7 +413,7 @@ public function setCard($card) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation */ public function getBuyerInformation() { @@ -422,7 +422,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -434,7 +434,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -443,7 +443,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) @@ -476,7 +476,7 @@ public function setProcessingInformation($processingInformation) /** * Gets merchantInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + * @return \CyberSource\Model\TmsMerchantInformation */ public function getMerchantInformation() { @@ -485,7 +485,7 @@ public function getMerchantInformation() /** * Sets merchantInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation $merchantInformation + * @param \CyberSource\Model\TmsMerchantInformation $merchantInformation * @return $this */ public function setMerchantInformation($merchantInformation) @@ -497,7 +497,7 @@ public function setMerchantInformation($merchantInformation) /** * Gets instrumentIdentifier - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier */ public function getInstrumentIdentifier() { @@ -506,7 +506,7 @@ public function getInstrumentIdentifier() /** * Sets instrumentIdentifier - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier * @return $this */ public function setInstrumentIdentifier($instrumentIdentifier) @@ -518,7 +518,7 @@ public function setInstrumentIdentifier($instrumentIdentifier) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata */ public function getMetadata() { @@ -527,7 +527,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -539,7 +539,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded */ public function getEmbedded() { @@ -548,7 +548,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/PostTokenizeRequest.php b/lib/Model/PostTokenizeRequest.php new file mode 100644 index 000000000..7d56ffa64 --- /dev/null +++ b/lib/Model/PostTokenizeRequest.php @@ -0,0 +1,272 @@ + '\CyberSource\Model\Tmsv2tokenizeProcessingInformation', + 'tokenInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformation' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'processingInformation' => null, + 'tokenInformation' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'processingInformation' => 'processingInformation', + 'tokenInformation' => 'tokenInformation' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'processingInformation' => 'setProcessingInformation', + 'tokenInformation' => 'setTokenInformation' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'processingInformation' => 'getProcessingInformation', + 'tokenInformation' => 'getTokenInformation' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['processingInformation'] = isset($data['processingInformation']) ? $data['processingInformation'] : null; + $this->container['tokenInformation'] = isset($data['tokenInformation']) ? $data['tokenInformation'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets processingInformation + * @return \CyberSource\Model\Tmsv2tokenizeProcessingInformation + */ + public function getProcessingInformation() + { + return $this->container['processingInformation']; + } + + /** + * Sets processingInformation + * @param \CyberSource\Model\Tmsv2tokenizeProcessingInformation $processingInformation + * @return $this + */ + public function setProcessingInformation($processingInformation) + { + $this->container['processingInformation'] = $processingInformation; + + return $this; + } + + /** + * Gets tokenInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformation + */ + public function getTokenInformation() + { + return $this->container['tokenInformation']; + } + + /** + * Sets tokenInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformation $tokenInformation + * @return $this + */ + public function setTokenInformation($tokenInformation) + { + $this->container['tokenInformation'] = $tokenInformation; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Ptsv2paymentsAggregatorInformation.php b/lib/Model/Ptsv2paymentsAggregatorInformation.php index 045a05b2d..221c1be46 100644 --- a/lib/Model/Ptsv2paymentsAggregatorInformation.php +++ b/lib/Model/Ptsv2paymentsAggregatorInformation.php @@ -60,7 +60,8 @@ class Ptsv2paymentsAggregatorInformation implements ArrayAccess 'city' => 'string', 'state' => 'string', 'postalCode' => 'string', - 'country' => 'string' + 'country' => 'string', + 'serviceProvidername' => 'string' ]; /** @@ -75,7 +76,8 @@ class Ptsv2paymentsAggregatorInformation implements ArrayAccess 'city' => null, 'state' => null, 'postalCode' => null, - 'country' => null + 'country' => null, + 'serviceProvidername' => null ]; public static function swaggerTypes() @@ -100,7 +102,8 @@ public static function swaggerFormats() 'city' => 'city', 'state' => 'state', 'postalCode' => 'postalCode', - 'country' => 'country' + 'country' => 'country', + 'serviceProvidername' => 'serviceProvidername' ]; @@ -116,7 +119,8 @@ public static function swaggerFormats() 'city' => 'setCity', 'state' => 'setState', 'postalCode' => 'setPostalCode', - 'country' => 'setCountry' + 'country' => 'setCountry', + 'serviceProvidername' => 'setServiceProvidername' ]; @@ -132,7 +136,8 @@ public static function swaggerFormats() 'city' => 'getCity', 'state' => 'getState', 'postalCode' => 'getPostalCode', - 'country' => 'getCountry' + 'country' => 'getCountry', + 'serviceProvidername' => 'getServiceProvidername' ]; public static function attributeMap() @@ -174,6 +179,7 @@ public function __construct(array $data = null) $this->container['state'] = isset($data['state']) ? $data['state'] : null; $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; $this->container['country'] = isset($data['country']) ? $data['country'] : null; + $this->container['serviceProvidername'] = isset($data['serviceProvidername']) ? $data['serviceProvidername'] : null; } /** @@ -368,6 +374,27 @@ public function setCountry($country) return $this; } + + /** + * Gets serviceProvidername + * @return string + */ + public function getServiceProvidername() + { + return $this->container['serviceProvidername']; + } + + /** + * Sets serviceProvidername + * @param string $serviceProvidername Contains transfer service provider name. + * @return $this + */ + public function setServiceProvidername($serviceProvidername) + { + $this->container['serviceProvidername'] = $serviceProvidername; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Rbsv1plansClientReferenceInformation.php b/lib/Model/Rbsv1plansClientReferenceInformation.php deleted file mode 100644 index 6142db5eb..000000000 --- a/lib/Model/Rbsv1plansClientReferenceInformation.php +++ /dev/null @@ -1,353 +0,0 @@ - 'string', - 'partner' => '\CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner', - 'applicationName' => 'string', - 'applicationVersion' => 'string', - 'applicationUser' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'comments' => null, - 'partner' => null, - 'applicationName' => null, - 'applicationVersion' => null, - 'applicationUser' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'comments' => 'comments', - 'partner' => 'partner', - 'applicationName' => 'applicationName', - 'applicationVersion' => 'applicationVersion', - 'applicationUser' => 'applicationUser' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'comments' => 'setComments', - 'partner' => 'setPartner', - 'applicationName' => 'setApplicationName', - 'applicationVersion' => 'setApplicationVersion', - 'applicationUser' => 'setApplicationUser' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'comments' => 'getComments', - 'partner' => 'getPartner', - 'applicationName' => 'getApplicationName', - 'applicationVersion' => 'getApplicationVersion', - 'applicationUser' => 'getApplicationUser' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['comments'] = isset($data['comments']) ? $data['comments'] : null; - $this->container['partner'] = isset($data['partner']) ? $data['partner'] : null; - $this->container['applicationName'] = isset($data['applicationName']) ? $data['applicationName'] : null; - $this->container['applicationVersion'] = isset($data['applicationVersion']) ? $data['applicationVersion'] : null; - $this->container['applicationUser'] = isset($data['applicationUser']) ? $data['applicationUser'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets comments - * @return string - */ - public function getComments() - { - return $this->container['comments']; - } - - /** - * Sets comments - * @param string $comments Brief description of the order or any comment you wish to add to the order. - * @return $this - */ - public function setComments($comments) - { - $this->container['comments'] = $comments; - - return $this; - } - - /** - * Gets partner - * @return \CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner - */ - public function getPartner() - { - return $this->container['partner']; - } - - /** - * Sets partner - * @param \CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner $partner - * @return $this - */ - public function setPartner($partner) - { - $this->container['partner'] = $partner; - - return $this; - } - - /** - * Gets applicationName - * @return string - */ - public function getApplicationName() - { - return $this->container['applicationName']; - } - - /** - * Sets applicationName - * @param string $applicationName The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. - * @return $this - */ - public function setApplicationName($applicationName) - { - $this->container['applicationName'] = $applicationName; - - return $this; - } - - /** - * Gets applicationVersion - * @return string - */ - public function getApplicationVersion() - { - return $this->container['applicationVersion']; - } - - /** - * Sets applicationVersion - * @param string $applicationVersion Version of the CyberSource application or integration used for a transaction. - * @return $this - */ - public function setApplicationVersion($applicationVersion) - { - $this->container['applicationVersion'] = $applicationVersion; - - return $this; - } - - /** - * Gets applicationUser - * @return string - */ - public function getApplicationUser() - { - return $this->container['applicationUser']; - } - - /** - * Sets applicationUser - * @param string $applicationUser The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. - * @return $this - */ - public function setApplicationUser($applicationUser) - { - $this->container['applicationUser'] = $applicationUser; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Rbsv1subscriptionsClientReferenceInformation.php b/lib/Model/Rbsv1subscriptionsClientReferenceInformation.php deleted file mode 100644 index 39610d760..000000000 --- a/lib/Model/Rbsv1subscriptionsClientReferenceInformation.php +++ /dev/null @@ -1,380 +0,0 @@ - 'string', - 'comments' => 'string', - 'partner' => '\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformationPartner', - 'applicationName' => 'string', - 'applicationVersion' => 'string', - 'applicationUser' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'code' => null, - 'comments' => null, - 'partner' => null, - 'applicationName' => null, - 'applicationVersion' => null, - 'applicationUser' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'code' => 'code', - 'comments' => 'comments', - 'partner' => 'partner', - 'applicationName' => 'applicationName', - 'applicationVersion' => 'applicationVersion', - 'applicationUser' => 'applicationUser' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'code' => 'setCode', - 'comments' => 'setComments', - 'partner' => 'setPartner', - 'applicationName' => 'setApplicationName', - 'applicationVersion' => 'setApplicationVersion', - 'applicationUser' => 'setApplicationUser' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'code' => 'getCode', - 'comments' => 'getComments', - 'partner' => 'getPartner', - 'applicationName' => 'getApplicationName', - 'applicationVersion' => 'getApplicationVersion', - 'applicationUser' => 'getApplicationUser' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['code'] = isset($data['code']) ? $data['code'] : null; - $this->container['comments'] = isset($data['comments']) ? $data['comments'] : null; - $this->container['partner'] = isset($data['partner']) ? $data['partner'] : null; - $this->container['applicationName'] = isset($data['applicationName']) ? $data['applicationName'] : null; - $this->container['applicationVersion'] = isset($data['applicationVersion']) ? $data['applicationVersion'] : null; - $this->container['applicationUser'] = isset($data['applicationUser']) ? $data['applicationUser'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets code - * @return string - */ - public function getCode() - { - return $this->container['code']; - } - - /** - * Sets code - * @param string $code > Deprecated: This field is ignored. Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. - * @return $this - */ - public function setCode($code) - { - $this->container['code'] = $code; - - return $this; - } - - /** - * Gets comments - * @return string - */ - public function getComments() - { - return $this->container['comments']; - } - - /** - * Sets comments - * @param string $comments > Deprecated: This field is ignored. Brief description of the order or any comment you wish to add to the order. - * @return $this - */ - public function setComments($comments) - { - $this->container['comments'] = $comments; - - return $this; - } - - /** - * Gets partner - * @return \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformationPartner - */ - public function getPartner() - { - return $this->container['partner']; - } - - /** - * Sets partner - * @param \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformationPartner $partner - * @return $this - */ - public function setPartner($partner) - { - $this->container['partner'] = $partner; - - return $this; - } - - /** - * Gets applicationName - * @return string - */ - public function getApplicationName() - { - return $this->container['applicationName']; - } - - /** - * Sets applicationName - * @param string $applicationName > Deprecated: This field is ignored. The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. - * @return $this - */ - public function setApplicationName($applicationName) - { - $this->container['applicationName'] = $applicationName; - - return $this; - } - - /** - * Gets applicationVersion - * @return string - */ - public function getApplicationVersion() - { - return $this->container['applicationVersion']; - } - - /** - * Sets applicationVersion - * @param string $applicationVersion > Deprecated: This field is ignored. Version of the CyberSource application or integration used for a transaction. - * @return $this - */ - public function setApplicationVersion($applicationVersion) - { - $this->container['applicationVersion'] = $applicationVersion; - - return $this; - } - - /** - * Gets applicationUser - * @return string - */ - public function getApplicationUser() - { - return $this->container['applicationUser']; - } - - /** - * Sets applicationUser - * @param string $applicationUser > Deprecated: This field is ignored. The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. - * @return $this - */ - public function setApplicationUser($applicationUser) - { - $this->container['applicationUser'] = $applicationUser; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/Rbsv1subscriptionsClientReferenceInformationPartner.php b/lib/Model/Rbsv1subscriptionsClientReferenceInformationPartner.php deleted file mode 100644 index 7c1cc00b1..000000000 --- a/lib/Model/Rbsv1subscriptionsClientReferenceInformationPartner.php +++ /dev/null @@ -1,272 +0,0 @@ - 'string', - 'solutionId' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'developerId' => null, - 'solutionId' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'developerId' => 'developerId', - 'solutionId' => 'solutionId' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'developerId' => 'setDeveloperId', - 'solutionId' => 'setSolutionId' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'developerId' => 'getDeveloperId', - 'solutionId' => 'getSolutionId' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['developerId'] = isset($data['developerId']) ? $data['developerId'] : null; - $this->container['solutionId'] = isset($data['solutionId']) ? $data['solutionId'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - return true; - } - - - /** - * Gets developerId - * @return string - */ - public function getDeveloperId() - { - return $this->container['developerId']; - } - - /** - * Sets developerId - * @param string $developerId > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect. - * @return $this - */ - public function setDeveloperId($developerId) - { - $this->container['developerId'] = $developerId; - - return $this; - } - - /** - * Gets solutionId - * @return string - */ - public function getSolutionId() - { - return $this->container['solutionId']; - } - - /** - * Sets solutionId - * @param string $solutionId > This field is ignored when you provide the `subscriptionInformation.originalTransactionId` or update the subscription. Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. - * @return $this - */ - public function setSolutionId($solutionId) - { - $this->container['solutionId'] = $solutionId; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - #[\ReturnTypeWillChange] - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - #[\ReturnTypeWillChange] - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - #[\ReturnTypeWillChange] - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/ShippingAddressListForCustomerEmbedded.php b/lib/Model/ShippingAddressListForCustomerEmbedded.php index eff086dc2..7b1814681 100644 --- a/lib/Model/ShippingAddressListForCustomerEmbedded.php +++ b/lib/Model/ShippingAddressListForCustomerEmbedded.php @@ -54,7 +54,7 @@ class ShippingAddressListForCustomerEmbedded implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'shippingAddresses' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress[]' + 'shippingAddresses' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress[]' ]; /** @@ -162,7 +162,7 @@ public function valid() /** * Gets shippingAddresses - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress[] + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress[] */ public function getShippingAddresses() { @@ -171,7 +171,7 @@ public function getShippingAddresses() /** * Sets shippingAddresses - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress[] $shippingAddresses + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress[] $shippingAddresses * @return $this */ public function setShippingAddresses($shippingAddresses) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.php b/lib/Model/TmsMerchantInformation.php similarity index 87% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.php rename to lib/Model/TmsMerchantInformation.php index 6d07a2428..d2557f9da 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation.php +++ b/lib/Model/TmsMerchantInformation.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor' + 'merchantDescriptor' => '\CyberSource\Model\TmsMerchantInformationMerchantDescriptor' ]; /** @@ -161,7 +161,7 @@ public function valid() /** * Gets merchantDescriptor - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor + * @return \CyberSource\Model\TmsMerchantInformationMerchantDescriptor */ public function getMerchantDescriptor() { @@ -170,7 +170,7 @@ public function getMerchantDescriptor() /** * Sets merchantDescriptor - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor $merchantDescriptor + * @param \CyberSource\Model\TmsMerchantInformationMerchantDescriptor $merchantDescriptor * @return $this */ public function setMerchantDescriptor($merchantDescriptor) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.php b/lib/Model/TmsMerchantInformationMerchantDescriptor.php similarity index 92% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.php rename to lib/Model/TmsMerchantInformationMerchantDescriptor.php index 1781773fa..65709dd35 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformationMerchantDescriptor.php +++ b/lib/Model/TmsMerchantInformationMerchantDescriptor.php @@ -1,6 +1,6 @@ 'string[]', + 'actionTokenTypes' => 'string[]' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'actionList' => null, + 'actionTokenTypes' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'actionList' => 'actionList', + 'actionTokenTypes' => 'actionTokenTypes' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'actionList' => 'setActionList', + 'actionTokenTypes' => 'setActionTokenTypes' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'actionList' => 'getActionList', + 'actionTokenTypes' => 'getActionTokenTypes' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['actionList'] = isset($data['actionList']) ? $data['actionList'] : null; + $this->container['actionTokenTypes'] = isset($data['actionTokenTypes']) ? $data['actionTokenTypes'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets actionList + * @return string[] + */ + public function getActionList() + { + return $this->container['actionList']; + } + + /** + * Sets actionList + * @param string[] $actionList Array of actions (one or more) to be included in the tokenize request. Possible Values: - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your tokenize request. + * @return $this + */ + public function setActionList($actionList) + { + $this->container['actionList'] = $actionList; + + return $this; + } + + /** + * Gets actionTokenTypes + * @return string[] + */ + public function getActionTokenTypes() + { + return $this->container['actionTokenTypes']; + } + + /** + * Sets actionTokenTypes + * @param string[] $actionTokenTypes TMS tokens types you want to perform the action on. Possible Values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress - tokenizedCard + * @return $this + */ + public function setActionTokenTypes($actionTokenTypes) + { + $this->container['actionTokenTypes'] = $actionTokenTypes; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Tmsv2tokenizeTokenInformation.php b/lib/Model/Tmsv2tokenizeTokenInformation.php new file mode 100644 index 000000000..337084f99 --- /dev/null +++ b/lib/Model/Tmsv2tokenizeTokenInformation.php @@ -0,0 +1,380 @@ + 'string', + 'transientTokenJwt' => 'string', + 'customer' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomer', + 'shippingAddress' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress', + 'paymentInstrument' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument', + 'instrumentIdentifier' => '\CyberSource\Model\TmsEmbeddedInstrumentIdentifier' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'jti' => null, + 'transientTokenJwt' => null, + 'customer' => null, + 'shippingAddress' => null, + 'paymentInstrument' => null, + 'instrumentIdentifier' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'jti' => 'jti', + 'transientTokenJwt' => 'transientTokenJwt', + 'customer' => 'customer', + 'shippingAddress' => 'shippingAddress', + 'paymentInstrument' => 'paymentInstrument', + 'instrumentIdentifier' => 'instrumentIdentifier' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'jti' => 'setJti', + 'transientTokenJwt' => 'setTransientTokenJwt', + 'customer' => 'setCustomer', + 'shippingAddress' => 'setShippingAddress', + 'paymentInstrument' => 'setPaymentInstrument', + 'instrumentIdentifier' => 'setInstrumentIdentifier' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'jti' => 'getJti', + 'transientTokenJwt' => 'getTransientTokenJwt', + 'customer' => 'getCustomer', + 'shippingAddress' => 'getShippingAddress', + 'paymentInstrument' => 'getPaymentInstrument', + 'instrumentIdentifier' => 'getInstrumentIdentifier' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['jti'] = isset($data['jti']) ? $data['jti'] : null; + $this->container['transientTokenJwt'] = isset($data['transientTokenJwt']) ? $data['transientTokenJwt'] : null; + $this->container['customer'] = isset($data['customer']) ? $data['customer'] : null; + $this->container['shippingAddress'] = isset($data['shippingAddress']) ? $data['shippingAddress'] : null; + $this->container['paymentInstrument'] = isset($data['paymentInstrument']) ? $data['paymentInstrument'] : null; + $this->container['instrumentIdentifier'] = isset($data['instrumentIdentifier']) ? $data['instrumentIdentifier'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets jti + * @return string + */ + public function getJti() + { + return $this->container['jti']; + } + + /** + * Sets jti + * @param string $jti TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). + * @return $this + */ + public function setJti($jti) + { + $this->container['jti'] = $jti; + + return $this; + } + + /** + * Gets transientTokenJwt + * @return string + */ + public function getTransientTokenJwt() + { + return $this->container['transientTokenJwt']; + } + + /** + * Sets transientTokenJwt + * @param string $transientTokenJwt Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. + * @return $this + */ + public function setTransientTokenJwt($transientTokenJwt) + { + $this->container['transientTokenJwt'] = $transientTokenJwt; + + return $this; + } + + /** + * Gets customer + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomer + */ + public function getCustomer() + { + return $this->container['customer']; + } + + /** + * Sets customer + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomer $customer + * @return $this + */ + public function setCustomer($customer) + { + $this->container['customer'] = $customer; + + return $this; + } + + /** + * Gets shippingAddress + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress + */ + public function getShippingAddress() + { + return $this->container['shippingAddress']; + } + + /** + * Sets shippingAddress + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress $shippingAddress + * @return $this + */ + public function setShippingAddress($shippingAddress) + { + $this->container['shippingAddress'] = $shippingAddress; + + return $this; + } + + /** + * Gets paymentInstrument + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument + */ + public function getPaymentInstrument() + { + return $this->container['paymentInstrument']; + } + + /** + * Sets paymentInstrument + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument $paymentInstrument + * @return $this + */ + public function setPaymentInstrument($paymentInstrument) + { + $this->container['paymentInstrument'] = $paymentInstrument; + + return $this; + } + + /** + * Gets instrumentIdentifier + * @return \CyberSource\Model\TmsEmbeddedInstrumentIdentifier + */ + public function getInstrumentIdentifier() + { + return $this->container['instrumentIdentifier']; + } + + /** + * Sets instrumentIdentifier + * @param \CyberSource\Model\TmsEmbeddedInstrumentIdentifier $instrumentIdentifier + * @return $this + */ + public function setInstrumentIdentifier($instrumentIdentifier) + { + $this->container['instrumentIdentifier'] = $instrumentIdentifier; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Tmsv2tokenizeTokenInformationCustomer.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomer.php new file mode 100644 index 000000000..b70a173c1 --- /dev/null +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomer.php @@ -0,0 +1,488 @@ + '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks', + 'id' => 'string', + 'objectInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation', + 'clientReferenceInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation', + 'merchantDefinedInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[]', + 'defaultPaymentInstrument' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument', + 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'links' => null, + 'id' => null, + 'objectInformation' => null, + 'buyerInformation' => null, + 'clientReferenceInformation' => null, + 'merchantDefinedInformation' => null, + 'defaultPaymentInstrument' => null, + 'defaultShippingAddress' => null, + 'metadata' => null, + 'embedded' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'links' => '_links', + 'id' => 'id', + 'objectInformation' => 'objectInformation', + 'buyerInformation' => 'buyerInformation', + 'clientReferenceInformation' => 'clientReferenceInformation', + 'merchantDefinedInformation' => 'merchantDefinedInformation', + 'defaultPaymentInstrument' => 'defaultPaymentInstrument', + 'defaultShippingAddress' => 'defaultShippingAddress', + 'metadata' => 'metadata', + 'embedded' => '_embedded' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'links' => 'setLinks', + 'id' => 'setId', + 'objectInformation' => 'setObjectInformation', + 'buyerInformation' => 'setBuyerInformation', + 'clientReferenceInformation' => 'setClientReferenceInformation', + 'merchantDefinedInformation' => 'setMerchantDefinedInformation', + 'defaultPaymentInstrument' => 'setDefaultPaymentInstrument', + 'defaultShippingAddress' => 'setDefaultShippingAddress', + 'metadata' => 'setMetadata', + 'embedded' => 'setEmbedded' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'links' => 'getLinks', + 'id' => 'getId', + 'objectInformation' => 'getObjectInformation', + 'buyerInformation' => 'getBuyerInformation', + 'clientReferenceInformation' => 'getClientReferenceInformation', + 'merchantDefinedInformation' => 'getMerchantDefinedInformation', + 'defaultPaymentInstrument' => 'getDefaultPaymentInstrument', + 'defaultShippingAddress' => 'getDefaultShippingAddress', + 'metadata' => 'getMetadata', + 'embedded' => 'getEmbedded' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['links'] = isset($data['links']) ? $data['links'] : null; + $this->container['id'] = isset($data['id']) ? $data['id'] : null; + $this->container['objectInformation'] = isset($data['objectInformation']) ? $data['objectInformation'] : null; + $this->container['buyerInformation'] = isset($data['buyerInformation']) ? $data['buyerInformation'] : null; + $this->container['clientReferenceInformation'] = isset($data['clientReferenceInformation']) ? $data['clientReferenceInformation'] : null; + $this->container['merchantDefinedInformation'] = isset($data['merchantDefinedInformation']) ? $data['merchantDefinedInformation'] : null; + $this->container['defaultPaymentInstrument'] = isset($data['defaultPaymentInstrument']) ? $data['defaultPaymentInstrument'] : null; + $this->container['defaultShippingAddress'] = isset($data['defaultShippingAddress']) ? $data['defaultShippingAddress'] : null; + $this->container['metadata'] = isset($data['metadata']) ? $data['metadata'] : null; + $this->container['embedded'] = isset($data['embedded']) ? $data['embedded'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets links + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks + */ + public function getLinks() + { + return $this->container['links']; + } + + /** + * Sets links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinks $links + * @return $this + */ + public function setLinks($links) + { + $this->container['links'] = $links; + + return $this; + } + + /** + * Gets id + * @return string + */ + public function getId() + { + return $this->container['id']; + } + + /** + * Sets id + * @param string $id The Id of the Customer Token. + * @return $this + */ + public function setId($id) + { + $this->container['id'] = $id; + + return $this; + } + + /** + * Gets objectInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation + */ + public function getObjectInformation() + { + return $this->container['objectInformation']; + } + + /** + * Sets objectInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerObjectInformation $objectInformation + * @return $this + */ + public function setObjectInformation($objectInformation) + { + $this->container['objectInformation'] = $objectInformation; + + return $this; + } + + /** + * Gets buyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation + */ + public function getBuyerInformation() + { + return $this->container['buyerInformation']; + } + + /** + * Sets buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerBuyerInformation $buyerInformation + * @return $this + */ + public function setBuyerInformation($buyerInformation) + { + $this->container['buyerInformation'] = $buyerInformation; + + return $this; + } + + /** + * Gets clientReferenceInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation + */ + public function getClientReferenceInformation() + { + return $this->container['clientReferenceInformation']; + } + + /** + * Sets clientReferenceInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerClientReferenceInformation $clientReferenceInformation + * @return $this + */ + public function setClientReferenceInformation($clientReferenceInformation) + { + $this->container['clientReferenceInformation'] = $clientReferenceInformation; + + return $this; + } + + /** + * Gets merchantDefinedInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[] + */ + public function getMerchantDefinedInformation() + { + return $this->container['merchantDefinedInformation']; + } + + /** + * Sets merchantDefinedInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMerchantDefinedInformation[] $merchantDefinedInformation Object containing the custom data that the merchant defines. + * @return $this + */ + public function setMerchantDefinedInformation($merchantDefinedInformation) + { + $this->container['merchantDefinedInformation'] = $merchantDefinedInformation; + + return $this; + } + + /** + * Gets defaultPaymentInstrument + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument + */ + public function getDefaultPaymentInstrument() + { + return $this->container['defaultPaymentInstrument']; + } + + /** + * Sets defaultPaymentInstrument + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultPaymentInstrument $defaultPaymentInstrument + * @return $this + */ + public function setDefaultPaymentInstrument($defaultPaymentInstrument) + { + $this->container['defaultPaymentInstrument'] = $defaultPaymentInstrument; + + return $this; + } + + /** + * Gets defaultShippingAddress + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress + */ + public function getDefaultShippingAddress() + { + return $this->container['defaultShippingAddress']; + } + + /** + * Sets defaultShippingAddress + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerDefaultShippingAddress $defaultShippingAddress + * @return $this + */ + public function setDefaultShippingAddress($defaultShippingAddress) + { + $this->container['defaultShippingAddress'] = $defaultShippingAddress; + + return $this; + } + + /** + * Gets metadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerMetadata $metadata + * @return $this + */ + public function setMetadata($metadata) + { + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets embedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded + */ + public function getEmbedded() + { + return $this->container['embedded']; + } + + /** + * Sets embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbedded $embedded + * @return $this + */ + public function setEmbedded($embedded) + { + $this->container['embedded'] = $embedded; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Tmsv2customersBuyerInformation.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerBuyerInformation.php similarity index 95% rename from lib/Model/Tmsv2customersBuyerInformation.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerBuyerInformation.php index 84dbe837a..435ab8b7f 100644 --- a/lib/Model/Tmsv2customersBuyerInformation.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerBuyerInformation.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument', - 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress' + 'defaultPaymentInstrument' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument', + 'defaultShippingAddress' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress' ]; /** @@ -168,7 +168,7 @@ public function valid() /** * Gets defaultPaymentInstrument - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument */ public function getDefaultPaymentInstrument() { @@ -177,7 +177,7 @@ public function getDefaultPaymentInstrument() /** * Sets defaultPaymentInstrument - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrument $defaultPaymentInstrument + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument $defaultPaymentInstrument * @return $this */ public function setDefaultPaymentInstrument($defaultPaymentInstrument) @@ -189,7 +189,7 @@ public function setDefaultPaymentInstrument($defaultPaymentInstrument) /** * Gets defaultShippingAddress - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress */ public function getDefaultShippingAddress() { @@ -198,7 +198,7 @@ public function getDefaultShippingAddress() /** * Sets defaultShippingAddress - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddress $defaultShippingAddress + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddress $defaultShippingAddress * @return $this */ public function setDefaultShippingAddress($defaultShippingAddress) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrument.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.php similarity index 80% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrument.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.php index 54e0ca67f..374c879fb 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrument.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrument.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks', 'id' => 'string', 'object' => 'string', 'default' => 'bool', 'state' => 'string', 'type' => 'string', - 'bankAccount' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount', - 'card' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard', - 'buyerInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation', - 'billTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo', + 'bankAccount' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount', + 'card' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard', + 'buyerInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation', + 'billTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo', 'processingInformation' => '\CyberSource\Model\TmsPaymentInstrumentProcessingInfo', - 'merchantInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation', - 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata', - 'embedded' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded' + 'merchantInformation' => '\CyberSource\Model\TmsMerchantInformation', + 'instrumentIdentifier' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata', + 'embedded' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded' ]; /** @@ -245,7 +245,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks */ public function getLinks() { @@ -254,7 +254,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinks $links * @return $this */ public function setLinks($links) @@ -371,7 +371,7 @@ public function setType($type) /** * Gets bankAccount - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount */ public function getBankAccount() { @@ -380,7 +380,7 @@ public function getBankAccount() /** * Sets bankAccount - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount $bankAccount * @return $this */ public function setBankAccount($bankAccount) @@ -392,7 +392,7 @@ public function setBankAccount($bankAccount) /** * Gets card - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard */ public function getCard() { @@ -401,7 +401,7 @@ public function getCard() /** * Sets card - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCard $card + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard $card * @return $this */ public function setCard($card) @@ -413,7 +413,7 @@ public function setCard($card) /** * Gets buyerInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation */ public function getBuyerInformation() { @@ -422,7 +422,7 @@ public function getBuyerInformation() /** * Sets buyerInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformation $buyerInformation * @return $this */ public function setBuyerInformation($buyerInformation) @@ -434,7 +434,7 @@ public function setBuyerInformation($buyerInformation) /** * Gets billTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo */ public function getBillTo() { @@ -443,7 +443,7 @@ public function getBillTo() /** * Sets billTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBillTo $billTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBillTo $billTo * @return $this */ public function setBillTo($billTo) @@ -476,7 +476,7 @@ public function setProcessingInformation($processingInformation) /** * Gets merchantInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation + * @return \CyberSource\Model\TmsMerchantInformation */ public function getMerchantInformation() { @@ -485,7 +485,7 @@ public function getMerchantInformation() /** * Sets merchantInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMerchantInformation $merchantInformation + * @param \CyberSource\Model\TmsMerchantInformation $merchantInformation * @return $this */ public function setMerchantInformation($merchantInformation) @@ -497,7 +497,7 @@ public function setMerchantInformation($merchantInformation) /** * Gets instrumentIdentifier - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier */ public function getInstrumentIdentifier() { @@ -506,7 +506,7 @@ public function getInstrumentIdentifier() /** * Sets instrumentIdentifier - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentInstrumentIdentifier $instrumentIdentifier * @return $this */ public function setInstrumentIdentifier($instrumentIdentifier) @@ -518,7 +518,7 @@ public function setInstrumentIdentifier($instrumentIdentifier) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata */ public function getMetadata() { @@ -527,7 +527,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentMetadata $metadata * @return $this */ public function setMetadata($metadata) @@ -539,7 +539,7 @@ public function setMetadata($metadata) /** * Gets embedded - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded */ public function getEmbedded() { @@ -548,7 +548,7 @@ public function getEmbedded() /** * Sets embedded - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbedded $embedded + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentEmbedded $embedded * @return $this */ public function setEmbedded($embedded) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.php similarity index 92% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.php index dda5c80b8..ca07d66a0 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBankAccount.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBankAccount.php @@ -1,6 +1,6 @@ 'string', 'currency' => 'string', 'dateOfBirth' => '\DateTime', - 'personalIdentification' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]' + 'personalIdentification' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[]' ]; /** @@ -242,7 +242,7 @@ public function setDateOfBirth($dateOfBirth) /** * Gets personalIdentification - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] */ public function getPersonalIdentification() { @@ -251,7 +251,7 @@ public function getPersonalIdentification() /** * Sets personalIdentification - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] $personalIdentification + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification[] $personalIdentification * @return $this */ public function setPersonalIdentification($personalIdentification) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.php similarity index 92% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.php index 4a25ad61c..545a79fa8 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy.php @@ -1,6 +1,6 @@ 'string', 'type' => 'string', - 'issuedBy' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy' + 'issuedBy' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy' ]; /** @@ -215,7 +215,7 @@ public function setType($type) /** * Gets issuedBy - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy */ public function getIssuedBy() { @@ -224,7 +224,7 @@ public function getIssuedBy() /** * Sets issuedBy - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy $issuedBy + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentBuyerInformationIssuedBy $issuedBy * @return $this */ public function setIssuedBy($issuedBy) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.php similarity index 94% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.php index 869e13bb2..212a2ddc8 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCard.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCard.php @@ -1,6 +1,6 @@ 'string', 'useAs' => 'string', 'hash' => 'string', - 'tokenizedInformation' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation' + 'tokenizedInformation' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation' ]; /** @@ -377,7 +377,7 @@ public function setHash($hash) /** * Gets tokenizedInformation - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation */ public function getTokenizedInformation() { @@ -386,7 +386,7 @@ public function getTokenizedInformation() /** * Sets tokenizedInformation - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation $tokenizedInformation + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation $tokenizedInformation * @return $this */ public function setTokenizedInformation($tokenizedInformation) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.php similarity index 93% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.php index f40e54d3a..f0d3c122e 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentCardTokenizedInformation.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf', - 'customer' => '\CyberSource\Model\Tmsv2customersLinksSelf' + 'self' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf', + 'customer' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf' ]; /** @@ -167,7 +167,7 @@ public function valid() /** * Gets self - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf */ public function getSelf() { @@ -176,7 +176,7 @@ public function getSelf() /** * Sets self - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf $self + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf $self * @return $this */ public function setSelf($self) @@ -188,7 +188,7 @@ public function setSelf($self) /** * Gets customer - * @return \CyberSource\Model\Tmsv2customersLinksSelf + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf */ public function getCustomer() { @@ -197,7 +197,7 @@ public function getCustomer() /** * Sets customer - * @param \CyberSource\Model\Tmsv2customersLinksSelf $customer + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf $customer * @return $this */ public function setCustomer($customer) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.php similarity index 92% rename from lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.php index 9d6791e7e..c1a708270 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentLinksSelf.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultPaymentInstrumentLinksSelf.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks', + 'links' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks', 'id' => 'string', 'default' => 'bool', - 'shipTo' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo', - 'metadata' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata' + 'shipTo' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo', + 'metadata' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata' ]; /** @@ -185,7 +185,7 @@ public function valid() /** * Gets links - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks */ public function getLinks() { @@ -194,7 +194,7 @@ public function getLinks() /** * Sets links - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinks $links + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks $links * @return $this */ public function setLinks($links) @@ -248,7 +248,7 @@ public function setDefault($default) /** * Gets shipTo - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo */ public function getShipTo() { @@ -257,7 +257,7 @@ public function getShipTo() /** * Sets shipTo - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressShipTo $shipTo + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressShipTo $shipTo * @return $this */ public function setShipTo($shipTo) @@ -269,7 +269,7 @@ public function setShipTo($shipTo) /** * Gets metadata - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata */ public function getMetadata() { @@ -278,7 +278,7 @@ public function getMetadata() /** * Sets metadata - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressMetadata $metadata + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressMetadata $metadata * @return $this */ public function setMetadata($metadata) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinks.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.php similarity index 83% rename from lib/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinks.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.php index 1f595c639..a547764d0 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinks.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinks.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf', - 'customer' => '\CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer' + 'self' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf', + 'customer' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer' ]; /** @@ -167,7 +167,7 @@ public function valid() /** * Gets self - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf */ public function getSelf() { @@ -176,7 +176,7 @@ public function getSelf() /** * Sets self - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksSelf $self + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksSelf $self * @return $this */ public function setSelf($self) @@ -188,7 +188,7 @@ public function setSelf($self) /** * Gets customer - * @return \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer */ public function getCustomer() { @@ -197,7 +197,7 @@ public function getCustomer() /** * Sets customer - * @param \CyberSource\Model\Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer $customer + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer $customer * @return $this */ public function setCustomer($customer) diff --git a/lib/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.php similarity index 92% rename from lib/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.php index 81263c766..f52f50665 100644 --- a/lib/Model/Tmsv2customersEmbeddedDefaultShippingAddressLinksCustomer.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerEmbeddedDefaultShippingAddressLinksCustomer.php @@ -1,6 +1,6 @@ '\CyberSource\Model\Tmsv2customersLinksSelf', - 'paymentInstruments' => '\CyberSource\Model\Tmsv2customersLinksPaymentInstruments', - 'shippingAddress' => '\CyberSource\Model\Tmsv2customersLinksShippingAddress' + 'self' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf', + 'paymentInstruments' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments', + 'shippingAddress' => '\CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress' ]; /** @@ -173,7 +173,7 @@ public function valid() /** * Gets self - * @return \CyberSource\Model\Tmsv2customersLinksSelf + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf */ public function getSelf() { @@ -182,7 +182,7 @@ public function getSelf() /** * Sets self - * @param \CyberSource\Model\Tmsv2customersLinksSelf $self + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksSelf $self * @return $this */ public function setSelf($self) @@ -194,7 +194,7 @@ public function setSelf($self) /** * Gets paymentInstruments - * @return \CyberSource\Model\Tmsv2customersLinksPaymentInstruments + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments */ public function getPaymentInstruments() { @@ -203,7 +203,7 @@ public function getPaymentInstruments() /** * Sets paymentInstruments - * @param \CyberSource\Model\Tmsv2customersLinksPaymentInstruments $paymentInstruments + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments $paymentInstruments * @return $this */ public function setPaymentInstruments($paymentInstruments) @@ -215,7 +215,7 @@ public function setPaymentInstruments($paymentInstruments) /** * Gets shippingAddress - * @return \CyberSource\Model\Tmsv2customersLinksShippingAddress + * @return \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress */ public function getShippingAddress() { @@ -224,7 +224,7 @@ public function getShippingAddress() /** * Sets shippingAddress - * @param \CyberSource\Model\Tmsv2customersLinksShippingAddress $shippingAddress + * @param \CyberSource\Model\Tmsv2tokenizeTokenInformationCustomerLinksShippingAddress $shippingAddress * @return $this */ public function setShippingAddress($shippingAddress) diff --git a/lib/Model/Tmsv2customersLinksPaymentInstruments.php b/lib/Model/Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.php similarity index 93% rename from lib/Model/Tmsv2customersLinksPaymentInstruments.php rename to lib/Model/Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.php index 06992ce94..9620333f0 100644 --- a/lib/Model/Tmsv2customersLinksPaymentInstruments.php +++ b/lib/Model/Tmsv2tokenizeTokenInformationCustomerLinksPaymentInstruments.php @@ -1,6 +1,6 @@ 'string', + 'expirationMonth' => 'string', + 'expirationYear' => 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'last4' => null, + 'expirationMonth' => null, + 'expirationYear' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'last4' => 'last4', + 'expirationMonth' => 'expirationMonth', + 'expirationYear' => 'expirationYear' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'last4' => 'setLast4', + 'expirationMonth' => 'setExpirationMonth', + 'expirationYear' => 'setExpirationYear' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'last4' => 'getLast4', + 'expirationMonth' => 'getExpirationMonth', + 'expirationYear' => 'getExpirationYear' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['last4'] = isset($data['last4']) ? $data['last4'] : null; + $this->container['expirationMonth'] = isset($data['expirationMonth']) ? $data['expirationMonth'] : null; + $this->container['expirationYear'] = isset($data['expirationYear']) ? $data['expirationYear'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets last4 + * @return string + */ + public function getLast4() + { + return $this->container['last4']; + } + + /** + * Sets last4 + * @param string $last4 The new last 4 digits of the card number associated to the Tokenized Card. + * @return $this + */ + public function setLast4($last4) + { + $this->container['last4'] = $last4; + + return $this; + } + + /** + * Gets expirationMonth + * @return string + */ + public function getExpirationMonth() + { + return $this->container['expirationMonth']; + } + + /** + * Sets expirationMonth + * @param string $expirationMonth The new two-digit month of the card associated to the Tokenized Card. Format: `MM`. Possible Values: `01` through `12`. + * @return $this + */ + public function setExpirationMonth($expirationMonth) + { + $this->container['expirationMonth'] = $expirationMonth; + + return $this; + } + + /** + * Gets expirationYear + * @return string + */ + public function getExpirationYear() + { + return $this->container['expirationYear']; + } + + /** + * Sets expirationYear + * @param string $expirationYear The new four-digit year of the card associated to the Tokenized Card. Format: `YYYY`. + * @return $this + */ + public function setExpirationYear($expirationYear) + { + $this->container['expirationYear'] = $expirationYear; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.php b/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.php new file mode 100644 index 000000000..884e2c1e8 --- /dev/null +++ b/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadata.php @@ -0,0 +1,245 @@ + '\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'cardArt' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'cardArt' => 'cardArt' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'cardArt' => 'setCardArt' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'cardArt' => 'getCardArt' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['cardArt'] = isset($data['cardArt']) ? $data['cardArt'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets cardArt + * @return \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt + */ + public function getCardArt() + { + return $this->container['cardArt']; + } + + /** + * Sets cardArt + * @param \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt $cardArt + * @return $this + */ + public function setCardArt($cardArt) + { + $this->container['cardArt'] = $cardArt; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.php b/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.php new file mode 100644 index 000000000..574ada2e7 --- /dev/null +++ b/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArt.php @@ -0,0 +1,245 @@ + '\CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'combinedAsset' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'combinedAsset' => 'combinedAsset' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'combinedAsset' => 'setCombinedAsset' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'combinedAsset' => 'getCombinedAsset' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['combinedAsset'] = isset($data['combinedAsset']) ? $data['combinedAsset'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets combinedAsset + * @return \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset + */ + public function getCombinedAsset() + { + return $this->container['combinedAsset']; + } + + /** + * Sets combinedAsset + * @param \CyberSource\Model\Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset $combinedAsset + * @return $this + */ + public function setCombinedAsset($combinedAsset) + { + $this->container['combinedAsset'] = $combinedAsset; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.php b/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.php new file mode 100644 index 000000000..1a104a4c7 --- /dev/null +++ b/lib/Model/Tmsv2tokenizedcardstokenizedCardIdissuerlifecycleeventsimulationsMetadataCardArtCombinedAsset.php @@ -0,0 +1,245 @@ + 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'update' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'update' => 'update' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'update' => 'setUpdate' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'update' => 'getUpdate' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['update'] = isset($data['update']) ? $data['update'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets update + * @return string + */ + public function getUpdate() + { + return $this->container['update']; + } + + /** + * Sets update + * @param string $update Set to \"true\" to simulate an update to the combined card art asset associated with the Tokenized Card. + * @return $this + */ + public function setUpdate($update) + { + $this->container['update'] = $update; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/UpdateSubscription.php b/lib/Model/UpdateSubscription.php index 836267e96..6a9cfdba8 100644 --- a/lib/Model/UpdateSubscription.php +++ b/lib/Model/UpdateSubscription.php @@ -53,7 +53,7 @@ class UpdateSubscription implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'clientReferenceInformation' => '\CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation', + 'clientReferenceInformation' => '\CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation', 'processingInformation' => '\CyberSource\Model\Rbsv1subscriptionsProcessingInformation', 'planInformation' => '\CyberSource\Model\Rbsv1subscriptionsidPlanInformation', 'subscriptionInformation' => '\CyberSource\Model\Rbsv1subscriptionsidSubscriptionInformation', @@ -185,7 +185,7 @@ public function valid() /** * Gets clientReferenceInformation - * @return \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation + * @return \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation */ public function getClientReferenceInformation() { @@ -194,7 +194,7 @@ public function getClientReferenceInformation() /** * Sets clientReferenceInformation - * @param \CyberSource\Model\Rbsv1subscriptionsClientReferenceInformation $clientReferenceInformation + * @param \CyberSource\Model\GetAllSubscriptionsResponseClientReferenceInformation $clientReferenceInformation * @return $this */ public function setClientReferenceInformation($clientReferenceInformation) diff --git a/lib/Model/Upv1capturecontextsData.php b/lib/Model/Upv1capturecontextsData.php index 580d6cd6c..a7475c5ec 100644 --- a/lib/Model/Upv1capturecontextsData.php +++ b/lib/Model/Upv1capturecontextsData.php @@ -60,7 +60,9 @@ class Upv1capturecontextsData implements ArrayAccess 'merchantInformation' => '\CyberSource\Model\Upv1capturecontextsDataMerchantInformation', 'processingInformation' => '\CyberSource\Model\Upv1capturecontextsDataProcessingInformation', 'recipientInformation' => '\CyberSource\Model\Upv1capturecontextsDataRecipientInformation', - 'merchantDefinedInformation' => '\CyberSource\Model\Upv1capturecontextsDataMerchantDefinedInformation' + 'merchantDefinedInformation' => '\CyberSource\Model\Upv1capturecontextsDataMerchantDefinedInformation', + 'deviceInformation' => '\CyberSource\Model\Upv1capturecontextsDataDeviceInformation', + 'paymentInformation' => '\CyberSource\Model\Upv1capturecontextsDataPaymentInformation' ]; /** @@ -75,7 +77,9 @@ class Upv1capturecontextsData implements ArrayAccess 'merchantInformation' => null, 'processingInformation' => null, 'recipientInformation' => null, - 'merchantDefinedInformation' => null + 'merchantDefinedInformation' => null, + 'deviceInformation' => null, + 'paymentInformation' => null ]; public static function swaggerTypes() @@ -100,7 +104,9 @@ public static function swaggerFormats() 'merchantInformation' => 'merchantInformation', 'processingInformation' => 'processingInformation', 'recipientInformation' => 'recipientInformation', - 'merchantDefinedInformation' => 'merchantDefinedInformation' + 'merchantDefinedInformation' => 'merchantDefinedInformation', + 'deviceInformation' => 'deviceInformation', + 'paymentInformation' => 'paymentInformation' ]; @@ -116,7 +122,9 @@ public static function swaggerFormats() 'merchantInformation' => 'setMerchantInformation', 'processingInformation' => 'setProcessingInformation', 'recipientInformation' => 'setRecipientInformation', - 'merchantDefinedInformation' => 'setMerchantDefinedInformation' + 'merchantDefinedInformation' => 'setMerchantDefinedInformation', + 'deviceInformation' => 'setDeviceInformation', + 'paymentInformation' => 'setPaymentInformation' ]; @@ -132,7 +140,9 @@ public static function swaggerFormats() 'merchantInformation' => 'getMerchantInformation', 'processingInformation' => 'getProcessingInformation', 'recipientInformation' => 'getRecipientInformation', - 'merchantDefinedInformation' => 'getMerchantDefinedInformation' + 'merchantDefinedInformation' => 'getMerchantDefinedInformation', + 'deviceInformation' => 'getDeviceInformation', + 'paymentInformation' => 'getPaymentInformation' ]; public static function attributeMap() @@ -174,6 +184,8 @@ public function __construct(array $data = null) $this->container['processingInformation'] = isset($data['processingInformation']) ? $data['processingInformation'] : null; $this->container['recipientInformation'] = isset($data['recipientInformation']) ? $data['recipientInformation'] : null; $this->container['merchantDefinedInformation'] = isset($data['merchantDefinedInformation']) ? $data['merchantDefinedInformation'] : null; + $this->container['deviceInformation'] = isset($data['deviceInformation']) ? $data['deviceInformation'] : null; + $this->container['paymentInformation'] = isset($data['paymentInformation']) ? $data['paymentInformation'] : null; } /** @@ -368,6 +380,48 @@ public function setMerchantDefinedInformation($merchantDefinedInformation) return $this; } + + /** + * Gets deviceInformation + * @return \CyberSource\Model\Upv1capturecontextsDataDeviceInformation + */ + public function getDeviceInformation() + { + return $this->container['deviceInformation']; + } + + /** + * Sets deviceInformation + * @param \CyberSource\Model\Upv1capturecontextsDataDeviceInformation $deviceInformation + * @return $this + */ + public function setDeviceInformation($deviceInformation) + { + $this->container['deviceInformation'] = $deviceInformation; + + return $this; + } + + /** + * Gets paymentInformation + * @return \CyberSource\Model\Upv1capturecontextsDataPaymentInformation + */ + public function getPaymentInformation() + { + return $this->container['paymentInformation']; + } + + /** + * Sets paymentInformation + * @param \CyberSource\Model\Upv1capturecontextsDataPaymentInformation $paymentInformation + * @return $this + */ + public function setPaymentInformation($paymentInformation) + { + $this->container['paymentInformation'] = $paymentInformation; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataBuyerInformation.php b/lib/Model/Upv1capturecontextsDataBuyerInformation.php index b6e4a26d1..b39badd45 100644 --- a/lib/Model/Upv1capturecontextsDataBuyerInformation.php +++ b/lib/Model/Upv1capturecontextsDataBuyerInformation.php @@ -55,7 +55,9 @@ class Upv1capturecontextsDataBuyerInformation implements ArrayAccess protected static $swaggerTypes = [ 'personalIdentification' => '\CyberSource\Model\Upv1capturecontextsDataBuyerInformationPersonalIdentification', 'merchantCustomerId' => 'string', - 'companyTaxId' => 'string' + 'companyTaxId' => 'string', + 'dateOfBirth' => 'string', + 'language' => 'string' ]; /** @@ -65,7 +67,9 @@ class Upv1capturecontextsDataBuyerInformation implements ArrayAccess protected static $swaggerFormats = [ 'personalIdentification' => null, 'merchantCustomerId' => null, - 'companyTaxId' => null + 'companyTaxId' => null, + 'dateOfBirth' => null, + 'language' => null ]; public static function swaggerTypes() @@ -85,7 +89,9 @@ public static function swaggerFormats() protected static $attributeMap = [ 'personalIdentification' => 'personalIdentification', 'merchantCustomerId' => 'merchantCustomerId', - 'companyTaxId' => 'companyTaxId' + 'companyTaxId' => 'companyTaxId', + 'dateOfBirth' => 'dateOfBirth', + 'language' => 'language' ]; @@ -96,7 +102,9 @@ public static function swaggerFormats() protected static $setters = [ 'personalIdentification' => 'setPersonalIdentification', 'merchantCustomerId' => 'setMerchantCustomerId', - 'companyTaxId' => 'setCompanyTaxId' + 'companyTaxId' => 'setCompanyTaxId', + 'dateOfBirth' => 'setDateOfBirth', + 'language' => 'setLanguage' ]; @@ -107,7 +115,9 @@ public static function swaggerFormats() protected static $getters = [ 'personalIdentification' => 'getPersonalIdentification', 'merchantCustomerId' => 'getMerchantCustomerId', - 'companyTaxId' => 'getCompanyTaxId' + 'companyTaxId' => 'getCompanyTaxId', + 'dateOfBirth' => 'getDateOfBirth', + 'language' => 'getLanguage' ]; public static function attributeMap() @@ -144,6 +154,8 @@ public function __construct(array $data = null) $this->container['personalIdentification'] = isset($data['personalIdentification']) ? $data['personalIdentification'] : null; $this->container['merchantCustomerId'] = isset($data['merchantCustomerId']) ? $data['merchantCustomerId'] : null; $this->container['companyTaxId'] = isset($data['companyTaxId']) ? $data['companyTaxId'] : null; + $this->container['dateOfBirth'] = isset($data['dateOfBirth']) ? $data['dateOfBirth'] : null; + $this->container['language'] = isset($data['language']) ? $data['language'] : null; } /** @@ -203,7 +215,7 @@ public function getMerchantCustomerId() /** * Sets merchantCustomerId - * @param string $merchantCustomerId + * @param string $merchantCustomerId The Merchant Customer ID * @return $this */ public function setMerchantCustomerId($merchantCustomerId) @@ -224,7 +236,7 @@ public function getCompanyTaxId() /** * Sets companyTaxId - * @param string $companyTaxId + * @param string $companyTaxId The Company Tax ID * @return $this */ public function setCompanyTaxId($companyTaxId) @@ -233,6 +245,48 @@ public function setCompanyTaxId($companyTaxId) return $this; } + + /** + * Gets dateOfBirth + * @return string + */ + public function getDateOfBirth() + { + return $this->container['dateOfBirth']; + } + + /** + * Sets dateOfBirth + * @param string $dateOfBirth The date of birth + * @return $this + */ + public function setDateOfBirth($dateOfBirth) + { + $this->container['dateOfBirth'] = $dateOfBirth; + + return $this; + } + + /** + * Gets language + * @return string + */ + public function getLanguage() + { + return $this->container['language']; + } + + /** + * Sets language + * @param string $language The preferred language + * @return $this + */ + public function setLanguage($language) + { + $this->container['language'] = $language; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.php b/lib/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.php index 27623d613..56cd56fe3 100644 --- a/lib/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.php +++ b/lib/Model/Upv1capturecontextsDataBuyerInformationPersonalIdentification.php @@ -170,7 +170,7 @@ public function getCpf() /** * Sets cpf - * @param string $cpf + * @param string $cpf CPF Number (Brazil). Must be 11 digits in length. * @return $this */ public function setCpf($cpf) diff --git a/lib/Model/Upv1capturecontextsDataClientReferenceInformationPartner.php b/lib/Model/Upv1capturecontextsDataClientReferenceInformationPartner.php index ee675d514..a040a794f 100644 --- a/lib/Model/Upv1capturecontextsDataClientReferenceInformationPartner.php +++ b/lib/Model/Upv1capturecontextsDataClientReferenceInformationPartner.php @@ -82,7 +82,7 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'developerId' => 'developerId', - 'solutionId' => 'SolutionId' + 'solutionId' => 'solutionId' ]; diff --git a/lib/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.php b/lib/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.php index 6571e5b71..e0c4f0106 100644 --- a/lib/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.php +++ b/lib/Model/Upv1capturecontextsDataConsumerAuthenticationInformation.php @@ -54,7 +54,8 @@ class Upv1capturecontextsDataConsumerAuthenticationInformation implements ArrayA */ protected static $swaggerTypes = [ 'challengeCode' => 'string', - 'messageCategory' => 'string' + 'messageCategory' => 'string', + 'acsWindowSize' => 'string' ]; /** @@ -63,7 +64,8 @@ class Upv1capturecontextsDataConsumerAuthenticationInformation implements ArrayA */ protected static $swaggerFormats = [ 'challengeCode' => null, - 'messageCategory' => null + 'messageCategory' => null, + 'acsWindowSize' => null ]; public static function swaggerTypes() @@ -82,7 +84,8 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'challengeCode' => 'challengeCode', - 'messageCategory' => 'messageCategory' + 'messageCategory' => 'messageCategory', + 'acsWindowSize' => 'acsWindowSize' ]; @@ -92,7 +95,8 @@ public static function swaggerFormats() */ protected static $setters = [ 'challengeCode' => 'setChallengeCode', - 'messageCategory' => 'setMessageCategory' + 'messageCategory' => 'setMessageCategory', + 'acsWindowSize' => 'setAcsWindowSize' ]; @@ -102,7 +106,8 @@ public static function swaggerFormats() */ protected static $getters = [ 'challengeCode' => 'getChallengeCode', - 'messageCategory' => 'getMessageCategory' + 'messageCategory' => 'getMessageCategory', + 'acsWindowSize' => 'getAcsWindowSize' ]; public static function attributeMap() @@ -138,6 +143,7 @@ public function __construct(array $data = null) { $this->container['challengeCode'] = isset($data['challengeCode']) ? $data['challengeCode'] : null; $this->container['messageCategory'] = isset($data['messageCategory']) ? $data['messageCategory'] : null; + $this->container['acsWindowSize'] = isset($data['acsWindowSize']) ? $data['acsWindowSize'] : null; } /** @@ -176,7 +182,7 @@ public function getChallengeCode() /** * Sets challengeCode - * @param string $challengeCode + * @param string $challengeCode The challenge code * @return $this */ public function setChallengeCode($challengeCode) @@ -197,7 +203,7 @@ public function getMessageCategory() /** * Sets messageCategory - * @param string $messageCategory + * @param string $messageCategory The message category * @return $this */ public function setMessageCategory($messageCategory) @@ -206,6 +212,27 @@ public function setMessageCategory($messageCategory) return $this; } + + /** + * Gets acsWindowSize + * @return string + */ + public function getAcsWindowSize() + { + return $this->container['acsWindowSize']; + } + + /** + * Sets acsWindowSize + * @param string $acsWindowSize The acs window size + * @return $this + */ + public function setAcsWindowSize($acsWindowSize) + { + $this->container['acsWindowSize'] = $acsWindowSize; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataDeviceInformation.php b/lib/Model/Upv1capturecontextsDataDeviceInformation.php new file mode 100644 index 000000000..52623f419 --- /dev/null +++ b/lib/Model/Upv1capturecontextsDataDeviceInformation.php @@ -0,0 +1,245 @@ + 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'ipAddress' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'ipAddress' => 'ipAddress' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'ipAddress' => 'setIpAddress' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'ipAddress' => 'getIpAddress' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['ipAddress'] = isset($data['ipAddress']) ? $data['ipAddress'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets ipAddress + * @return string + */ + public function getIpAddress() + { + return $this->container['ipAddress']; + } + + /** + * Sets ipAddress + * @param string $ipAddress The IP Address + * @return $this + */ + public function setIpAddress($ipAddress) + { + $this->container['ipAddress'] = $ipAddress; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.php b/lib/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.php index c4e91b266..f3749b80d 100644 --- a/lib/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.php +++ b/lib/Model/Upv1capturecontextsDataMerchantInformationMerchantDescriptor.php @@ -53,7 +53,14 @@ class Upv1capturecontextsDataMerchantInformationMerchantDescriptor implements Ar * @var string[] */ protected static $swaggerTypes = [ - 'name' => 'string' + 'name' => 'string', + 'alternateName' => 'string', + 'locality' => 'string', + 'phone' => 'string', + 'country' => 'string', + 'postalCode' => 'string', + 'administrativeArea' => 'string', + 'address1' => 'string' ]; /** @@ -61,7 +68,14 @@ class Upv1capturecontextsDataMerchantInformationMerchantDescriptor implements Ar * @var string[] */ protected static $swaggerFormats = [ - 'name' => null + 'name' => null, + 'alternateName' => null, + 'locality' => null, + 'phone' => null, + 'country' => null, + 'postalCode' => null, + 'administrativeArea' => null, + 'address1' => null ]; public static function swaggerTypes() @@ -79,7 +93,14 @@ public static function swaggerFormats() * @var string[] */ protected static $attributeMap = [ - 'name' => 'name' + 'name' => 'name', + 'alternateName' => 'alternateName', + 'locality' => 'locality', + 'phone' => 'phone', + 'country' => 'country', + 'postalCode' => 'postalCode', + 'administrativeArea' => 'administrativeArea', + 'address1' => 'address1' ]; @@ -88,7 +109,14 @@ public static function swaggerFormats() * @var string[] */ protected static $setters = [ - 'name' => 'setName' + 'name' => 'setName', + 'alternateName' => 'setAlternateName', + 'locality' => 'setLocality', + 'phone' => 'setPhone', + 'country' => 'setCountry', + 'postalCode' => 'setPostalCode', + 'administrativeArea' => 'setAdministrativeArea', + 'address1' => 'setAddress1' ]; @@ -97,7 +125,14 @@ public static function swaggerFormats() * @var string[] */ protected static $getters = [ - 'name' => 'getName' + 'name' => 'getName', + 'alternateName' => 'getAlternateName', + 'locality' => 'getLocality', + 'phone' => 'getPhone', + 'country' => 'getCountry', + 'postalCode' => 'getPostalCode', + 'administrativeArea' => 'getAdministrativeArea', + 'address1' => 'getAddress1' ]; public static function attributeMap() @@ -132,6 +167,13 @@ public static function getters() public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['alternateName'] = isset($data['alternateName']) ? $data['alternateName'] : null; + $this->container['locality'] = isset($data['locality']) ? $data['locality'] : null; + $this->container['phone'] = isset($data['phone']) ? $data['phone'] : null; + $this->container['country'] = isset($data['country']) ? $data['country'] : null; + $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; + $this->container['administrativeArea'] = isset($data['administrativeArea']) ? $data['administrativeArea'] : null; + $this->container['address1'] = isset($data['address1']) ? $data['address1'] : null; } /** @@ -179,6 +221,153 @@ public function setName($name) return $this; } + + /** + * Gets alternateName + * @return string + */ + public function getAlternateName() + { + return $this->container['alternateName']; + } + + /** + * Sets alternateName + * @param string $alternateName The alternate name of the merchant + * @return $this + */ + public function setAlternateName($alternateName) + { + $this->container['alternateName'] = $alternateName; + + return $this; + } + + /** + * Gets locality + * @return string + */ + public function getLocality() + { + return $this->container['locality']; + } + + /** + * Sets locality + * @param string $locality The locality of the merchant + * @return $this + */ + public function setLocality($locality) + { + $this->container['locality'] = $locality; + + return $this; + } + + /** + * Gets phone + * @return string + */ + public function getPhone() + { + return $this->container['phone']; + } + + /** + * Sets phone + * @param string $phone The phone number of the merchant + * @return $this + */ + public function setPhone($phone) + { + $this->container['phone'] = $phone; + + return $this; + } + + /** + * Gets country + * @return string + */ + public function getCountry() + { + return $this->container['country']; + } + + /** + * Sets country + * @param string $country The country code of the merchant + * @return $this + */ + public function setCountry($country) + { + $this->container['country'] = $country; + + return $this; + } + + /** + * Gets postalCode + * @return string + */ + public function getPostalCode() + { + return $this->container['postalCode']; + } + + /** + * Sets postalCode + * @param string $postalCode The postal code of the merchant + * @return $this + */ + public function setPostalCode($postalCode) + { + $this->container['postalCode'] = $postalCode; + + return $this; + } + + /** + * Gets administrativeArea + * @return string + */ + public function getAdministrativeArea() + { + return $this->container['administrativeArea']; + } + + /** + * Sets administrativeArea + * @param string $administrativeArea The administrative area of the merchant + * @return $this + */ + public function setAdministrativeArea($administrativeArea) + { + $this->container['administrativeArea'] = $administrativeArea; + + return $this; + } + + /** + * Gets address1 + * @return string + */ + public function getAddress1() + { + return $this->container['address1']; + } + + /** + * Sets address1 + * @param string $address1 The first line of the merchant's address + * @return $this + */ + public function setAddress1($address1) + { + $this->container['address1'] = $address1; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataOrderInformation.php b/lib/Model/Upv1capturecontextsDataOrderInformation.php index 7fea4d26c..fd2442548 100644 --- a/lib/Model/Upv1capturecontextsDataOrderInformation.php +++ b/lib/Model/Upv1capturecontextsDataOrderInformation.php @@ -56,7 +56,8 @@ class Upv1capturecontextsDataOrderInformation implements ArrayAccess 'amountDetails' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationAmountDetails', 'billTo' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationBillTo', 'shipTo' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationShipTo', - 'lineItems' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationLineItems' + 'lineItems' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationLineItems', + 'invoiceDetails' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationInvoiceDetails' ]; /** @@ -67,7 +68,8 @@ class Upv1capturecontextsDataOrderInformation implements ArrayAccess 'amountDetails' => null, 'billTo' => null, 'shipTo' => null, - 'lineItems' => null + 'lineItems' => null, + 'invoiceDetails' => null ]; public static function swaggerTypes() @@ -88,7 +90,8 @@ public static function swaggerFormats() 'amountDetails' => 'amountDetails', 'billTo' => 'billTo', 'shipTo' => 'shipTo', - 'lineItems' => 'lineItems' + 'lineItems' => 'lineItems', + 'invoiceDetails' => 'invoiceDetails' ]; @@ -100,7 +103,8 @@ public static function swaggerFormats() 'amountDetails' => 'setAmountDetails', 'billTo' => 'setBillTo', 'shipTo' => 'setShipTo', - 'lineItems' => 'setLineItems' + 'lineItems' => 'setLineItems', + 'invoiceDetails' => 'setInvoiceDetails' ]; @@ -112,7 +116,8 @@ public static function swaggerFormats() 'amountDetails' => 'getAmountDetails', 'billTo' => 'getBillTo', 'shipTo' => 'getShipTo', - 'lineItems' => 'getLineItems' + 'lineItems' => 'getLineItems', + 'invoiceDetails' => 'getInvoiceDetails' ]; public static function attributeMap() @@ -150,6 +155,7 @@ public function __construct(array $data = null) $this->container['billTo'] = isset($data['billTo']) ? $data['billTo'] : null; $this->container['shipTo'] = isset($data['shipTo']) ? $data['shipTo'] : null; $this->container['lineItems'] = isset($data['lineItems']) ? $data['lineItems'] : null; + $this->container['invoiceDetails'] = isset($data['invoiceDetails']) ? $data['invoiceDetails'] : null; } /** @@ -260,6 +266,27 @@ public function setLineItems($lineItems) return $this; } + + /** + * Gets invoiceDetails + * @return \CyberSource\Model\Upv1capturecontextsDataOrderInformationInvoiceDetails + */ + public function getInvoiceDetails() + { + return $this->container['invoiceDetails']; + } + + /** + * Sets invoiceDetails + * @param \CyberSource\Model\Upv1capturecontextsDataOrderInformationInvoiceDetails $invoiceDetails + * @return $this + */ + public function setInvoiceDetails($invoiceDetails) + { + $this->container['invoiceDetails'] = $invoiceDetails; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetails.php b/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetails.php index 717ac21e4..159b82ee1 100644 --- a/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetails.php +++ b/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetails.php @@ -59,7 +59,8 @@ class Upv1capturecontextsDataOrderInformationAmountDetails implements ArrayAcces 'discountAmount' => 'string', 'subTotalAmount' => 'string', 'serviceFeeAmount' => 'string', - 'taxAmount' => 'string' + 'taxAmount' => 'string', + 'taxDetails' => '\CyberSource\Model\Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails' ]; /** @@ -73,7 +74,8 @@ class Upv1capturecontextsDataOrderInformationAmountDetails implements ArrayAcces 'discountAmount' => null, 'subTotalAmount' => null, 'serviceFeeAmount' => null, - 'taxAmount' => null + 'taxAmount' => null, + 'taxDetails' => null ]; public static function swaggerTypes() @@ -97,7 +99,8 @@ public static function swaggerFormats() 'discountAmount' => 'discountAmount', 'subTotalAmount' => 'subTotalAmount', 'serviceFeeAmount' => 'serviceFeeAmount', - 'taxAmount' => 'taxAmount' + 'taxAmount' => 'taxAmount', + 'taxDetails' => 'taxDetails' ]; @@ -112,7 +115,8 @@ public static function swaggerFormats() 'discountAmount' => 'setDiscountAmount', 'subTotalAmount' => 'setSubTotalAmount', 'serviceFeeAmount' => 'setServiceFeeAmount', - 'taxAmount' => 'setTaxAmount' + 'taxAmount' => 'setTaxAmount', + 'taxDetails' => 'setTaxDetails' ]; @@ -127,7 +131,8 @@ public static function swaggerFormats() 'discountAmount' => 'getDiscountAmount', 'subTotalAmount' => 'getSubTotalAmount', 'serviceFeeAmount' => 'getServiceFeeAmount', - 'taxAmount' => 'getTaxAmount' + 'taxAmount' => 'getTaxAmount', + 'taxDetails' => 'getTaxDetails' ]; public static function attributeMap() @@ -168,6 +173,7 @@ public function __construct(array $data = null) $this->container['subTotalAmount'] = isset($data['subTotalAmount']) ? $data['subTotalAmount'] : null; $this->container['serviceFeeAmount'] = isset($data['serviceFeeAmount']) ? $data['serviceFeeAmount'] : null; $this->container['taxAmount'] = isset($data['taxAmount']) ? $data['taxAmount'] : null; + $this->container['taxDetails'] = isset($data['taxDetails']) ? $data['taxDetails'] : null; } /** @@ -341,6 +347,27 @@ public function setTaxAmount($taxAmount) return $this; } + + /** + * Gets taxDetails + * @return \CyberSource\Model\Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails + */ + public function getTaxDetails() + { + return $this->container['taxDetails']; + } + + /** + * Sets taxDetails + * @param \CyberSource\Model\Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails $taxDetails + * @return $this + */ + public function setTaxDetails($taxDetails) + { + $this->container['taxDetails'] = $taxDetails; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.php b/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.php new file mode 100644 index 000000000..39086cd50 --- /dev/null +++ b/lib/Model/Upv1capturecontextsDataOrderInformationAmountDetailsTaxDetails.php @@ -0,0 +1,272 @@ + 'string', + 'type' => 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'taxId' => null, + 'type' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'taxId' => 'taxId', + 'type' => 'type' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'taxId' => 'setTaxId', + 'type' => 'setType' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'taxId' => 'getTaxId', + 'type' => 'getType' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['taxId'] = isset($data['taxId']) ? $data['taxId'] : null; + $this->container['type'] = isset($data['type']) ? $data['type'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets taxId + * @return string + */ + public function getTaxId() + { + return $this->container['taxId']; + } + + /** + * Sets taxId + * @param string $taxId This field defines the tax identifier/registration number + * @return $this + */ + public function setTaxId($taxId) + { + $this->container['taxId'] = $taxId; + + return $this; + } + + /** + * Gets type + * @return string + */ + public function getType() + { + return $this->container['type']; + } + + /** + * Sets type + * @param string $type This field defines the Tax type code (N=National, S=State, L=Local etc) + * @return $this + */ + public function setType($type) + { + $this->container['type'] = $type; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Upv1capturecontextsDataOrderInformationInvoiceDetails.php b/lib/Model/Upv1capturecontextsDataOrderInformationInvoiceDetails.php new file mode 100644 index 000000000..c3df3f5a7 --- /dev/null +++ b/lib/Model/Upv1capturecontextsDataOrderInformationInvoiceDetails.php @@ -0,0 +1,272 @@ + 'string', + 'productDescription' => 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'invoiceNumber' => null, + 'productDescription' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'invoiceNumber' => 'invoiceNumber', + 'productDescription' => 'productDescription' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'invoiceNumber' => 'setInvoiceNumber', + 'productDescription' => 'setProductDescription' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'invoiceNumber' => 'getInvoiceNumber', + 'productDescription' => 'getProductDescription' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['invoiceNumber'] = isset($data['invoiceNumber']) ? $data['invoiceNumber'] : null; + $this->container['productDescription'] = isset($data['productDescription']) ? $data['productDescription'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets invoiceNumber + * @return string + */ + public function getInvoiceNumber() + { + return $this->container['invoiceNumber']; + } + + /** + * Sets invoiceNumber + * @param string $invoiceNumber Invoice number + * @return $this + */ + public function setInvoiceNumber($invoiceNumber) + { + $this->container['invoiceNumber'] = $invoiceNumber; + + return $this; + } + + /** + * Gets productDescription + * @return string + */ + public function getProductDescription() + { + return $this->container['productDescription']; + } + + /** + * Sets productDescription + * @param string $productDescription Product description + * @return $this + */ + public function setProductDescription($productDescription) + { + $this->container['productDescription'] = $productDescription; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Upv1capturecontextsDataOrderInformationLineItems.php b/lib/Model/Upv1capturecontextsDataOrderInformationLineItems.php index ed82d729f..7de2ab4ce 100644 --- a/lib/Model/Upv1capturecontextsDataOrderInformationLineItems.php +++ b/lib/Model/Upv1capturecontextsDataOrderInformationLineItems.php @@ -356,7 +356,7 @@ public function getProductCode() /** * Sets productCode - * @param string $productCode + * @param string $productCode Code identifying the product. * @return $this */ public function setProductCode($productCode) @@ -377,7 +377,7 @@ public function getProductName() /** * Sets productName - * @param string $productName + * @param string $productName Name of the product. * @return $this */ public function setProductName($productName) @@ -398,7 +398,7 @@ public function getProductSku() /** * Sets productSku - * @param string $productSku + * @param string $productSku Stock Keeping Unit identifier * @return $this */ public function setProductSku($productSku) @@ -419,7 +419,7 @@ public function getQuantity() /** * Sets quantity - * @param int $quantity + * @param int $quantity Quantity of the product * @return $this */ public function setQuantity($quantity) @@ -440,7 +440,7 @@ public function getUnitPrice() /** * Sets unitPrice - * @param string $unitPrice + * @param string $unitPrice Price per unit * @return $this */ public function setUnitPrice($unitPrice) @@ -461,7 +461,7 @@ public function getUnitOfMeasure() /** * Sets unitOfMeasure - * @param string $unitOfMeasure + * @param string $unitOfMeasure Unit of measure (e.g. EA, KG, LB) * @return $this */ public function setUnitOfMeasure($unitOfMeasure) @@ -482,7 +482,7 @@ public function getTotalAmount() /** * Sets totalAmount - * @param string $totalAmount + * @param string $totalAmount Total amount for the line item * @return $this */ public function setTotalAmount($totalAmount) @@ -503,7 +503,7 @@ public function getTaxAmount() /** * Sets taxAmount - * @param string $taxAmount + * @param string $taxAmount Tax amount applied * @return $this */ public function setTaxAmount($taxAmount) @@ -524,7 +524,7 @@ public function getTaxRate() /** * Sets taxRate - * @param string $taxRate + * @param string $taxRate Tax rate applied * @return $this */ public function setTaxRate($taxRate) @@ -545,7 +545,7 @@ public function getTaxAppliedAfterDiscount() /** * Sets taxAppliedAfterDiscount - * @param string $taxAppliedAfterDiscount + * @param string $taxAppliedAfterDiscount Indicates if tax applied after discount * @return $this */ public function setTaxAppliedAfterDiscount($taxAppliedAfterDiscount) @@ -566,7 +566,7 @@ public function getTaxStatusIndicator() /** * Sets taxStatusIndicator - * @param string $taxStatusIndicator + * @param string $taxStatusIndicator Tax status indicator * @return $this */ public function setTaxStatusIndicator($taxStatusIndicator) @@ -587,7 +587,7 @@ public function getTaxTypeCode() /** * Sets taxTypeCode - * @param string $taxTypeCode + * @param string $taxTypeCode Tax type code * @return $this */ public function setTaxTypeCode($taxTypeCode) @@ -608,7 +608,7 @@ public function getAmountIncludesTax() /** * Sets amountIncludesTax - * @param bool $amountIncludesTax + * @param bool $amountIncludesTax Indicates if amount includes tax * @return $this */ public function setAmountIncludesTax($amountIncludesTax) @@ -629,7 +629,7 @@ public function getTypeOfSupply() /** * Sets typeOfSupply - * @param string $typeOfSupply + * @param string $typeOfSupply Type of supply * @return $this */ public function setTypeOfSupply($typeOfSupply) @@ -650,7 +650,7 @@ public function getCommodityCode() /** * Sets commodityCode - * @param string $commodityCode + * @param string $commodityCode Commodity code * @return $this */ public function setCommodityCode($commodityCode) @@ -671,7 +671,7 @@ public function getDiscountAmount() /** * Sets discountAmount - * @param string $discountAmount + * @param string $discountAmount Discount amount applied * @return $this */ public function setDiscountAmount($discountAmount) @@ -692,7 +692,7 @@ public function getDiscountApplied() /** * Sets discountApplied - * @param bool $discountApplied + * @param bool $discountApplied Indicates if discount applied * @return $this */ public function setDiscountApplied($discountApplied) @@ -713,7 +713,7 @@ public function getDiscountRate() /** * Sets discountRate - * @param string $discountRate + * @param string $discountRate Discount rate applied * @return $this */ public function setDiscountRate($discountRate) @@ -734,7 +734,7 @@ public function getInvoiceNumber() /** * Sets invoiceNumber - * @param string $invoiceNumber + * @param string $invoiceNumber Invoice number for the line item * @return $this */ public function setInvoiceNumber($invoiceNumber) @@ -776,7 +776,7 @@ public function getFulfillmentType() /** * Sets fulfillmentType - * @param string $fulfillmentType + * @param string $fulfillmentType Fulfillment type * @return $this */ public function setFulfillmentType($fulfillmentType) @@ -797,7 +797,7 @@ public function getWeight() /** * Sets weight - * @param string $weight + * @param string $weight Weight of the product * @return $this */ public function setWeight($weight) @@ -818,7 +818,7 @@ public function getWeightIdentifier() /** * Sets weightIdentifier - * @param string $weightIdentifier + * @param string $weightIdentifier Weight identifier * @return $this */ public function setWeightIdentifier($weightIdentifier) @@ -839,7 +839,7 @@ public function getWeightUnit() /** * Sets weightUnit - * @param string $weightUnit + * @param string $weightUnit Unit of weight of the product * @return $this */ public function setWeightUnit($weightUnit) @@ -860,7 +860,7 @@ public function getReferenceDataCode() /** * Sets referenceDataCode - * @param string $referenceDataCode + * @param string $referenceDataCode Reference data code * @return $this */ public function setReferenceDataCode($referenceDataCode) @@ -881,7 +881,7 @@ public function getReferenceDataNumber() /** * Sets referenceDataNumber - * @param string $referenceDataNumber + * @param string $referenceDataNumber Reference data number * @return $this */ public function setReferenceDataNumber($referenceDataNumber) @@ -902,7 +902,7 @@ public function getUnitTaxAmount() /** * Sets unitTaxAmount - * @param string $unitTaxAmount + * @param string $unitTaxAmount Unit tax amount * @return $this */ public function setUnitTaxAmount($unitTaxAmount) @@ -923,7 +923,7 @@ public function getProductDescription() /** * Sets productDescription - * @param string $productDescription + * @param string $productDescription Description of the product * @return $this */ public function setProductDescription($productDescription) @@ -944,7 +944,7 @@ public function getGiftCardCurrency() /** * Sets giftCardCurrency - * @param string $giftCardCurrency + * @param string $giftCardCurrency Gift card currency * @return $this */ public function setGiftCardCurrency($giftCardCurrency) @@ -965,7 +965,7 @@ public function getShippingDestinationTypes() /** * Sets shippingDestinationTypes - * @param string $shippingDestinationTypes + * @param string $shippingDestinationTypes Shipping destination types * @return $this */ public function setShippingDestinationTypes($shippingDestinationTypes) @@ -986,7 +986,7 @@ public function getGift() /** * Sets gift - * @param bool $gift + * @param bool $gift Indicates if item is a gift * @return $this */ public function setGift($gift) diff --git a/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.php b/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.php index 2d420735e..6498b4b3d 100644 --- a/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.php +++ b/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsPassenger.php @@ -212,7 +212,7 @@ public function getType() /** * Sets type - * @param string $type + * @param string $type Passenger type * @return $this */ public function setType($type) @@ -233,7 +233,7 @@ public function getStatus() /** * Sets status - * @param string $status + * @param string $status Passenger status * @return $this */ public function setStatus($status) @@ -254,7 +254,7 @@ public function getPhone() /** * Sets phone - * @param string $phone + * @param string $phone Passenger phone number * @return $this */ public function setPhone($phone) @@ -275,7 +275,7 @@ public function getFirstName() /** * Sets firstName - * @param string $firstName + * @param string $firstName Passenger first name * @return $this */ public function setFirstName($firstName) @@ -296,7 +296,7 @@ public function getLastName() /** * Sets lastName - * @param string $lastName + * @param string $lastName Passenger last name * @return $this */ public function setLastName($lastName) @@ -317,7 +317,7 @@ public function getId() /** * Sets id - * @param string $id + * @param string $id Passenger ID * @return $this */ public function setId($id) @@ -338,7 +338,7 @@ public function getEmail() /** * Sets email - * @param string $email + * @param string $email Passenger email * @return $this */ public function setEmail($email) @@ -359,7 +359,7 @@ public function getNationality() /** * Sets nationality - * @param string $nationality + * @param string $nationality Passenger nationality * @return $this */ public function setNationality($nationality) diff --git a/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.php b/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.php index e396a0ba4..edd141703 100644 --- a/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.php +++ b/lib/Model/Upv1capturecontextsDataOrderInformationLineItemsTaxDetails.php @@ -206,7 +206,7 @@ public function getType() /** * Sets type - * @param string $type + * @param string $type Type of tax * @return $this */ public function setType($type) @@ -227,7 +227,7 @@ public function getAmount() /** * Sets amount - * @param string $amount + * @param string $amount Tax amount * @return $this */ public function setAmount($amount) @@ -248,7 +248,7 @@ public function getRate() /** * Sets rate - * @param string $rate + * @param string $rate Tax rate * @return $this */ public function setRate($rate) @@ -269,7 +269,7 @@ public function getCode() /** * Sets code - * @param string $code + * @param string $code Tax code * @return $this */ public function setCode($code) @@ -290,7 +290,7 @@ public function getTaxId() /** * Sets taxId - * @param string $taxId + * @param string $taxId Tax Identifier * @return $this */ public function setTaxId($taxId) @@ -311,7 +311,7 @@ public function getApplied() /** * Sets applied - * @param bool $applied + * @param bool $applied Indicates if tax applied * @return $this */ public function setApplied($applied) @@ -332,7 +332,7 @@ public function getExemptionCode() /** * Sets exemptionCode - * @param string $exemptionCode + * @param string $exemptionCode Tax exemption code * @return $this */ public function setExemptionCode($exemptionCode) diff --git a/lib/Model/Upv1capturecontextsDataPaymentInformation.php b/lib/Model/Upv1capturecontextsDataPaymentInformation.php new file mode 100644 index 000000000..5c69d1c7c --- /dev/null +++ b/lib/Model/Upv1capturecontextsDataPaymentInformation.php @@ -0,0 +1,245 @@ + '\CyberSource\Model\Upv1capturecontextsDataPaymentInformationCard' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'card' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'card' => 'card' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'card' => 'setCard' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'card' => 'getCard' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['card'] = isset($data['card']) ? $data['card'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets card + * @return \CyberSource\Model\Upv1capturecontextsDataPaymentInformationCard + */ + public function getCard() + { + return $this->container['card']; + } + + /** + * Sets card + * @param \CyberSource\Model\Upv1capturecontextsDataPaymentInformationCard $card + * @return $this + */ + public function setCard($card) + { + $this->container['card'] = $card; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Upv1capturecontextsDataPaymentInformationCard.php b/lib/Model/Upv1capturecontextsDataPaymentInformationCard.php new file mode 100644 index 000000000..6900596a4 --- /dev/null +++ b/lib/Model/Upv1capturecontextsDataPaymentInformationCard.php @@ -0,0 +1,245 @@ + 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * @var string[] + */ + protected static $swaggerFormats = [ + 'typeSelectionIndicator' => null + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'typeSelectionIndicator' => 'typeSelectionIndicator' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'typeSelectionIndicator' => 'setTypeSelectionIndicator' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'typeSelectionIndicator' => 'getTypeSelectionIndicator' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * Associative array for storing property values + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * @param mixed[] $data Associated array of property values initializing the model + */ + public function __construct(array $data = null) + { + $this->container['typeSelectionIndicator'] = isset($data['typeSelectionIndicator']) ? $data['typeSelectionIndicator'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + + return true; + } + + + /** + * Gets typeSelectionIndicator + * @return string + */ + public function getTypeSelectionIndicator() + { + return $this->container['typeSelectionIndicator']; + } + + /** + * Sets typeSelectionIndicator + * @param string $typeSelectionIndicator The card type selection indicator + * @return $this + */ + public function setTypeSelectionIndicator($typeSelectionIndicator) + { + $this->container['typeSelectionIndicator'] = $typeSelectionIndicator; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\CyberSource\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/lib/Model/Upv1capturecontextsDataProcessingInformation.php b/lib/Model/Upv1capturecontextsDataProcessingInformation.php index ff6e072e6..685ac0874 100644 --- a/lib/Model/Upv1capturecontextsDataProcessingInformation.php +++ b/lib/Model/Upv1capturecontextsDataProcessingInformation.php @@ -176,7 +176,7 @@ public function getReconciliationId() /** * Sets reconciliationId - * @param string $reconciliationId + * @param string $reconciliationId The reconciliation ID * @return $this */ public function setReconciliationId($reconciliationId) diff --git a/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.php b/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.php index b0ef63602..5f4e7272d 100644 --- a/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.php +++ b/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptions.php @@ -54,8 +54,13 @@ class Upv1capturecontextsDataProcessingInformationAuthorizationOptions implement */ protected static $swaggerTypes = [ 'aftIndicator' => 'bool', + 'authIndicator' => 'string', + 'ignoreCvResult' => 'bool', + 'ignoreAvsResult' => 'bool', 'initiator' => '\CyberSource\Model\Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator', - 'businessApplicationId' => 'string' + 'businessApplicationId' => 'string', + 'commerceIndicator' => 'string', + 'processingInstruction' => 'string' ]; /** @@ -64,8 +69,13 @@ class Upv1capturecontextsDataProcessingInformationAuthorizationOptions implement */ protected static $swaggerFormats = [ 'aftIndicator' => null, + 'authIndicator' => null, + 'ignoreCvResult' => null, + 'ignoreAvsResult' => null, 'initiator' => null, - 'businessApplicationId' => null + 'businessApplicationId' => null, + 'commerceIndicator' => null, + 'processingInstruction' => null ]; public static function swaggerTypes() @@ -84,8 +94,13 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'aftIndicator' => 'aftIndicator', + 'authIndicator' => 'authIndicator', + 'ignoreCvResult' => 'ignoreCvResult', + 'ignoreAvsResult' => 'ignoreAvsResult', 'initiator' => 'initiator', - 'businessApplicationId' => 'businessApplicationId' + 'businessApplicationId' => 'businessApplicationId', + 'commerceIndicator' => 'commerceIndicator', + 'processingInstruction' => 'processingInstruction' ]; @@ -95,8 +110,13 @@ public static function swaggerFormats() */ protected static $setters = [ 'aftIndicator' => 'setAftIndicator', + 'authIndicator' => 'setAuthIndicator', + 'ignoreCvResult' => 'setIgnoreCvResult', + 'ignoreAvsResult' => 'setIgnoreAvsResult', 'initiator' => 'setInitiator', - 'businessApplicationId' => 'setBusinessApplicationId' + 'businessApplicationId' => 'setBusinessApplicationId', + 'commerceIndicator' => 'setCommerceIndicator', + 'processingInstruction' => 'setProcessingInstruction' ]; @@ -106,8 +126,13 @@ public static function swaggerFormats() */ protected static $getters = [ 'aftIndicator' => 'getAftIndicator', + 'authIndicator' => 'getAuthIndicator', + 'ignoreCvResult' => 'getIgnoreCvResult', + 'ignoreAvsResult' => 'getIgnoreAvsResult', 'initiator' => 'getInitiator', - 'businessApplicationId' => 'getBusinessApplicationId' + 'businessApplicationId' => 'getBusinessApplicationId', + 'commerceIndicator' => 'getCommerceIndicator', + 'processingInstruction' => 'getProcessingInstruction' ]; public static function attributeMap() @@ -142,8 +167,13 @@ public static function getters() public function __construct(array $data = null) { $this->container['aftIndicator'] = isset($data['aftIndicator']) ? $data['aftIndicator'] : null; + $this->container['authIndicator'] = isset($data['authIndicator']) ? $data['authIndicator'] : null; + $this->container['ignoreCvResult'] = isset($data['ignoreCvResult']) ? $data['ignoreCvResult'] : null; + $this->container['ignoreAvsResult'] = isset($data['ignoreAvsResult']) ? $data['ignoreAvsResult'] : null; $this->container['initiator'] = isset($data['initiator']) ? $data['initiator'] : null; $this->container['businessApplicationId'] = isset($data['businessApplicationId']) ? $data['businessApplicationId'] : null; + $this->container['commerceIndicator'] = isset($data['commerceIndicator']) ? $data['commerceIndicator'] : null; + $this->container['processingInstruction'] = isset($data['processingInstruction']) ? $data['processingInstruction'] : null; } /** @@ -182,7 +212,7 @@ public function getAftIndicator() /** * Sets aftIndicator - * @param bool $aftIndicator + * @param bool $aftIndicator The AFT indicator * @return $this */ public function setAftIndicator($aftIndicator) @@ -192,6 +222,69 @@ public function setAftIndicator($aftIndicator) return $this; } + /** + * Gets authIndicator + * @return string + */ + public function getAuthIndicator() + { + return $this->container['authIndicator']; + } + + /** + * Sets authIndicator + * @param string $authIndicator The authorization indicator + * @return $this + */ + public function setAuthIndicator($authIndicator) + { + $this->container['authIndicator'] = $authIndicator; + + return $this; + } + + /** + * Gets ignoreCvResult + * @return bool + */ + public function getIgnoreCvResult() + { + return $this->container['ignoreCvResult']; + } + + /** + * Sets ignoreCvResult + * @param bool $ignoreCvResult Ignore the CV result + * @return $this + */ + public function setIgnoreCvResult($ignoreCvResult) + { + $this->container['ignoreCvResult'] = $ignoreCvResult; + + return $this; + } + + /** + * Gets ignoreAvsResult + * @return bool + */ + public function getIgnoreAvsResult() + { + return $this->container['ignoreAvsResult']; + } + + /** + * Sets ignoreAvsResult + * @param bool $ignoreAvsResult Ignore the AVS result + * @return $this + */ + public function setIgnoreAvsResult($ignoreAvsResult) + { + $this->container['ignoreAvsResult'] = $ignoreAvsResult; + + return $this; + } + /** * Gets initiator * @return \CyberSource\Model\Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator @@ -224,7 +317,7 @@ public function getBusinessApplicationId() /** * Sets businessApplicationId - * @param string $businessApplicationId + * @param string $businessApplicationId The business application Id * @return $this */ public function setBusinessApplicationId($businessApplicationId) @@ -233,6 +326,48 @@ public function setBusinessApplicationId($businessApplicationId) return $this; } + + /** + * Gets commerceIndicator + * @return string + */ + public function getCommerceIndicator() + { + return $this->container['commerceIndicator']; + } + + /** + * Sets commerceIndicator + * @param string $commerceIndicator The commerce indicator + * @return $this + */ + public function setCommerceIndicator($commerceIndicator) + { + $this->container['commerceIndicator'] = $commerceIndicator; + + return $this; + } + + /** + * Gets processingInstruction + * @return string + */ + public function getProcessingInstruction() + { + return $this->container['processingInstruction']; + } + + /** + * Sets processingInstruction + * @param string $processingInstruction The processing instruction + * @return $this + */ + public function setProcessingInstruction($processingInstruction) + { + $this->container['processingInstruction'] = $processingInstruction; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.php b/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.php index 05922197b..7b30f3105 100644 --- a/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.php +++ b/lib/Model/Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator.php @@ -176,7 +176,7 @@ public function getCredentialStoredOnFile() /** * Sets credentialStoredOnFile - * @param bool $credentialStoredOnFile + * @param bool $credentialStoredOnFile Store the credential on file * @return $this */ public function setCredentialStoredOnFile($credentialStoredOnFile) diff --git a/lib/Model/Upv1capturecontextsDataRecipientInformation.php b/lib/Model/Upv1capturecontextsDataRecipientInformation.php index a5e402c6d..034dbee25 100644 --- a/lib/Model/Upv1capturecontextsDataRecipientInformation.php +++ b/lib/Model/Upv1capturecontextsDataRecipientInformation.php @@ -59,7 +59,9 @@ class Upv1capturecontextsDataRecipientInformation implements ArrayAccess 'country' => 'string', 'accountId' => 'string', 'administrativeArea' => 'string', - 'accountType' => 'string' + 'accountType' => 'string', + 'dateOfBirth' => 'string', + 'postalCode' => 'string' ]; /** @@ -73,7 +75,9 @@ class Upv1capturecontextsDataRecipientInformation implements ArrayAccess 'country' => null, 'accountId' => null, 'administrativeArea' => null, - 'accountType' => null + 'accountType' => null, + 'dateOfBirth' => null, + 'postalCode' => null ]; public static function swaggerTypes() @@ -97,7 +101,9 @@ public static function swaggerFormats() 'country' => 'country', 'accountId' => 'accountId', 'administrativeArea' => 'administrativeArea', - 'accountType' => 'accountType' + 'accountType' => 'accountType', + 'dateOfBirth' => 'dateOfBirth', + 'postalCode' => 'postalCode' ]; @@ -112,7 +118,9 @@ public static function swaggerFormats() 'country' => 'setCountry', 'accountId' => 'setAccountId', 'administrativeArea' => 'setAdministrativeArea', - 'accountType' => 'setAccountType' + 'accountType' => 'setAccountType', + 'dateOfBirth' => 'setDateOfBirth', + 'postalCode' => 'setPostalCode' ]; @@ -127,7 +135,9 @@ public static function swaggerFormats() 'country' => 'getCountry', 'accountId' => 'getAccountId', 'administrativeArea' => 'getAdministrativeArea', - 'accountType' => 'getAccountType' + 'accountType' => 'getAccountType', + 'dateOfBirth' => 'getDateOfBirth', + 'postalCode' => 'getPostalCode' ]; public static function attributeMap() @@ -168,6 +178,8 @@ public function __construct(array $data = null) $this->container['accountId'] = isset($data['accountId']) ? $data['accountId'] : null; $this->container['administrativeArea'] = isset($data['administrativeArea']) ? $data['administrativeArea'] : null; $this->container['accountType'] = isset($data['accountType']) ? $data['accountType'] : null; + $this->container['dateOfBirth'] = isset($data['dateOfBirth']) ? $data['dateOfBirth'] : null; + $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; } /** @@ -341,6 +353,48 @@ public function setAccountType($accountType) return $this; } + + /** + * Gets dateOfBirth + * @return string + */ + public function getDateOfBirth() + { + return $this->container['dateOfBirth']; + } + + /** + * Sets dateOfBirth + * @param string $dateOfBirth The date of birth of the recipient + * @return $this + */ + public function setDateOfBirth($dateOfBirth) + { + $this->container['dateOfBirth'] = $dateOfBirth; + + return $this; + } + + /** + * Gets postalCode + * @return string + */ + public function getPostalCode() + { + return $this->container['postalCode']; + } + + /** + * Sets postalCode + * @param string $postalCode The postal code of the recipient + * @return $this + */ + public function setPostalCode($postalCode) + { + $this->container['postalCode'] = $postalCode; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/Upv1capturecontextsOrderInformation.php b/lib/Model/Upv1capturecontextsOrderInformation.php index b41cb71fc..50f666d9c 100644 --- a/lib/Model/Upv1capturecontextsOrderInformation.php +++ b/lib/Model/Upv1capturecontextsOrderInformation.php @@ -34,6 +34,7 @@ * Upv1capturecontextsOrderInformation Class Doc Comment * * @category Class + * @description If you need to include any fields within the data object, you must use the orderInformation object that is nested inside the data object. This ensures proper structure and compliance with the Unified Checkout schema. This top-level orderInformation field is not intended for use when working with the data object. * @package CyberSource * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen diff --git a/lib/Utilities/CaptureContext/CaptureContextParser.php b/lib/Utilities/CaptureContext/CaptureContextParser.php new file mode 100644 index 000000000..70c145264 --- /dev/null +++ b/lib/Utilities/CaptureContext/CaptureContextParser.php @@ -0,0 +1,184 @@ +getRunEnvironment(); + + // Try to get public key from cache + $publicKey = null; + $isPublicKeyFromCache = false; + + try { + $publicKey = Cache::getPublicKeyFromCache($runEnvironment, $kid); + $isPublicKeyFromCache = true; + } catch (Exception $cacheError) { + $isPublicKeyFromCache = false; + } + + // If not in cache, fetch from API and verify + if (!$isPublicKeyFromCache) { + return self::fetchPublicKeyAndVerify($jwtValue, $parsedJwt, $kid, $runEnvironment); + } + + // Try to verify with cached key + try { + JWTUtility::verifyJwt($jwtValue, $publicKey); + return $parsedJwt['payload']; + } catch (Exception $verificationError) { + // If verification fails with cached key, fetch fresh key and try again + return self::fetchPublicKeyAndVerify($jwtValue, $parsedJwt, $kid, $runEnvironment); + } + } + + /** + * Fetches public key from API and performs JWT verification + * + * This is a helper function that fetches the public key from the Flex API, + * caches it, and then verifies the JWT signature. + * + * @param string $jwtValue The JWT token + * @param array $parsedJwt The parsed JWT object (header, payload, signature) + * @param string $kid The key ID + * @param string $runEnvironment The runtime environment + * + * @return array The parsed JWT payload + * @throws JwtSignatureValidationException If signature verification fails + * @throws Exception If public key fetch fails + */ + private static function fetchPublicKeyAndVerify($jwtValue, $parsedJwt, $kid, $runEnvironment) + { + // Fetch public key from API + try { + $publicKey = self::fetchPublicKeyFromApi($kid, $runEnvironment); + } catch (Exception $fetchError) { + throw $fetchError; + } + + // Verify JWT with fetched public key + try { + JWTUtility::verifyJwt($jwtValue, $publicKey); + return $parsedJwt['payload']; + } catch (Exception $verificationError) { + throw new JwtSignatureValidationException('JWT validation failed' . $verificationError->getMessage(), $verificationError); + } + } + + /** + * Fetches public key from API and adds it to cache + * + * This function fetches the public key from the Flex API using the + * PublicKeyApiController and caches it for future use. + * + * @param string $kid The key ID + * @param string $runEnvironment The runtime environment + * + * @return array The public key in JWK format + * @throws Exception If the API call fails or returns invalid data + * @throws InvalidJwkException If the JWK cannot be parsed correctly + */ + private static function fetchPublicKeyFromApi($kid, $runEnvironment) + { + try { + $publicKey = PublicKeyApiController::fetchPublicKey($kid, $runEnvironment); + } catch (Exception $error) { + // Handle different error types + $errorMessage = $error->getMessage(); + + if (strpos($errorMessage, 'runEnvironment parameter is required') !== false) { + throw new Exception('Invalid Runtime Environment in Merchant Config'); + } elseif (strpos($errorMessage, 'No response received') !== false) { + throw new Exception('Error while trying to retrieve public key from server'); + } elseif (strpos($errorMessage, 'Failed to parse JWK') !== false) { + throw new InvalidJwkException('JWK received from server cannot be parsed correctly', $error); + } else { + throw new Exception('Error while trying to retrieve public key from server'); + } + } + + // Add public key to cache + try { + Cache::addPublicKeyToCache($runEnvironment, $kid, $publicKey); + } catch (Exception $cacheError) { + } + + return $publicKey; + } +} diff --git a/lib/Utilities/CaptureContext/PublicKeyApiController.php b/lib/Utilities/CaptureContext/PublicKeyApiController.php new file mode 100644 index 000000000..e1763c7d0 --- /dev/null +++ b/lib/Utilities/CaptureContext/PublicKeyApiController.php @@ -0,0 +1,126 @@ + $url, + CURLOPT_RETURNTRANSFER => true, + CURLOPT_HTTPHEADER => [ + 'Accept: application/json' + ], + CURLOPT_CONNECTTIMEOUT => 10, + CURLOPT_SSL_VERIFYPEER => true, + CURLOPT_SSL_VERIFYHOST => 2 + ]); + + // Execute the request + $response = curl_exec($curl); + $httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); + $curlError = curl_error($curl); + $curlErrno = curl_errno($curl); + + curl_close($curl); + + // Handle cURL errors + if ($curlErrno !== 0) { + if (!empty($curlError)) { + $error = new Exception("No response received - Failed to fetch public key for kid: {$kid}"); + $error->code = $curlErrno; + throw $error; + } else { + throw new Exception("Request setup error: Failed to fetch public key for kid: {$kid}"); + } + } + + // Handle HTTP errors + if ($httpCode < 200 || $httpCode >= 300) { + $error = new Exception("HTTP {$httpCode} - Failed to fetch public key for kid: {$kid}"); + $error->status = $httpCode; + $error->response = $response; + throw $error; + } + + // Validate response + if (empty($response)) { + throw new Exception('Empty response received from public key endpoint'); + } + + // Parse and process the JWK response + try { + // Ensure we have a JSON string + $jwkJsonString = $response; + + // Use JWTUtility to parse and validate the JWK + $publicKey = JWTUtility::getRSAPublicKeyFromJwk($jwkJsonString); + + if (empty($publicKey)) { + throw new Exception('Invalid public key received from JWK'); + } + + // Success - return the public key + return $publicKey; + + } catch (Exception $parseError) { + $error = new Exception("Failed to parse JWK response: {$parseError->getMessage()}"); + $error->originalError = $parseError; + throw $error; + } + } + +} diff --git a/test/Api/SubscriptionsApiTest.php b/test/Api/SubscriptionsApiTest.php index 2fcbd9b28..e550a458a 100644 --- a/test/Api/SubscriptionsApiTest.php +++ b/test/Api/SubscriptionsApiTest.php @@ -74,7 +74,7 @@ public static function tearDownAfterClass() /** * Test case for activateSubscription * - * Activate a Subscription. + * Reactivating a Suspended Subscription. * */ public function testActivateSubscription() diff --git a/test/Model/Tmsv2customersLinksSelfTest.php b/test/Api/TokenizeApiTest.php similarity index 62% rename from test/Model/Tmsv2customersLinksSelfTest.php rename to test/Api/TokenizeApiTest.php index 57d12bb03..9851a8060 100644 --- a/test/Model/Tmsv2customersLinksSelfTest.php +++ b/test/Api/TokenizeApiTest.php @@ -1,7 +1,6 @@