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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 8 additions & 0 deletions docs/AuthorizationOptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.AuthorizationOptions

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**initiator** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.md) | | [optional]


18 changes: 18 additions & 0 deletions docs/BillTo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CyberSource.BillTo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**firstName** | **String** | Customer’s first name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**lastName** | **String** | Customer’s last name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**company** | **String** | Name of the customer’s company. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**address1** | **String** | First line of the billing street address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**address2** | **String** | Additional address information. | [optional]
**locality** | **String** | City of the billing address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**administrativeArea** | **String** | State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**country** | **String** | Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**email** | **String** | Customer’s email address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
**phoneNumber** | **String** | Customer phone number. When you create a customer profile, the requirements depend on the payment method: * Credit cards — optional. * Electronic checks — contact your payment processor representative to find out if this field is required or optional. * PINless debits — optional. | [optional]


11 changes: 11 additions & 0 deletions docs/BuyerInformation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CyberSource.BuyerInformation

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**companyTaxID** | **String** | Tax identifier for the customer’s company. **Important**: Contact your TeleCheck representative to find out whether this field is required or optional. | [optional]
**currency** | **String** | Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha. | [optional]
**dateOBirth** | **String** | Date of birth of the customer. Format: `YYYY-MM-DD` or `YYYYMMDD` | [optional]
**personalIdentification** | [**[TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification]**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.md) | | [optional]


11 changes: 11 additions & 0 deletions docs/CardInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CyberSource.CardInfo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cardNumber** | **String** | Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. |
**cardExpirationMonth** | **String** | Two digit expiration month | [optional]
**cardExpirationYear** | **String** | Four digit expiration year | [optional]
**cardType** | **String** | Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. |


18 changes: 18 additions & 0 deletions docs/CheckPayerAuthEnrollmentRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CyberSource.CheckPayerAuthEnrollmentRequest

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**clientReferenceInformation** | [**Riskv1authenticationsClientReferenceInformation**](Riskv1authenticationsClientReferenceInformation.md) | | [optional]
**orderInformation** | [**Riskv1authenticationsOrderInformation**](Riskv1authenticationsOrderInformation.md) | | [optional]
**paymentInformation** | [**Riskv1authenticationsPaymentInformation**](Riskv1authenticationsPaymentInformation.md) | | [optional]
**buyerInformation** | [**Riskv1authenticationsBuyerInformation**](Riskv1authenticationsBuyerInformation.md) | | [optional]
**deviceInformation** | [**Riskv1authenticationsDeviceInformation**](Riskv1authenticationsDeviceInformation.md) | | [optional]
**merchantInformation** | [**Riskv1authenticationsMerchantInformation**](Riskv1authenticationsMerchantInformation.md) | | [optional]
**recurringPaymentInformation** | [**Riskv1authenticationsRecurringPaymentInformation**](Riskv1authenticationsRecurringPaymentInformation.md) | | [optional]
**consumerAuthenticationInformation** | [**Riskv1authenticationsConsumerAuthenticationInformation**](Riskv1authenticationsConsumerAuthenticationInformation.md) | | [optional]
**riskInformation** | [**Riskv1authenticationsRiskInformation**](Riskv1authenticationsRiskInformation.md) | | [optional]
**travelInformation** | [**Riskv1authenticationsTravelInformation**](Riskv1authenticationsTravelInformation.md) | | [optional]
**merchantDefinedInformation** | [**[Riskv1decisionsMerchantDefinedInformation]**](Riskv1decisionsMerchantDefinedInformation.md) | | [optional]


10 changes: 10 additions & 0 deletions docs/DerPublicKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.DerPublicKey

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**format** | **String** | Specifies the format of the public key; currently X.509. | [optional]
**algorithm** | **String** | Algorithm used to encrypt the public key. | [optional]
**publicKey** | **String** | Base64 encoded public key value. | [optional]


9 changes: 9 additions & 0 deletions docs/Detail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.Detail

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name of the field that threw the error. | [optional]
**location** | **String** | The location of the field that threw the error. | [optional]


35 changes: 35 additions & 0 deletions docs/EmbeddedInstrumentIdentifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CyberSource.EmbeddedInstrumentIdentifier

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional]
**_object** | **String** | Describes type of token. | [optional]
**state** | **String** | Current state of the token. | [optional]
**id** | **String** | The ID of the existing instrument identifier to be linked to the newly created payment instrument. | [optional]
**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional]
**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional]
**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional]
**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional]


<a name="ObjectEnum"></a>
## Enum: ObjectEnum


* `instrumentIdentifier` (value: `"instrumentIdentifier"`)




<a name="StateEnum"></a>
## Enum: StateEnum


* `ACTIVE` (value: `"ACTIVE"`)

* `CLOSED` (value: `"CLOSED"`)




10 changes: 10 additions & 0 deletions docs/Error.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.Error

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | | [optional]
**message** | **String** | The detailed message related to the type stated above. | [optional]
**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional]


13 changes: 13 additions & 0 deletions docs/ErrorBean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CyberSource.ErrorBean

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | Error code |
**message** | **String** | Error message |
**localizationKey** | **String** | Localization Key Name | [optional]
**correlationId** | **String** | Correlation Id | [optional]
**detail** | **String** | Error Detail | [optional]
**fields** | [**[InlineResponse400Fields]**](InlineResponse400Fields.md) | Error fields List | [optional]


10 changes: 10 additions & 0 deletions docs/ErrorFieldBean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.ErrorFieldBean

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**path** | **String** | Path of the failed property | [optional]
**message** | **String** | Error description about validation failed field | [optional]
**localizationKey** | **String** | Localized Key Name | [optional]


10 changes: 10 additions & 0 deletions docs/ErrorLinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.ErrorLinks

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**next** | [**[InlineResponseDefaultLinksNext]**](InlineResponseDefaultLinksNext.md) | | [optional]
**documentation** | [**[InlineResponseDefaultLinksNext]**](InlineResponseDefaultLinksNext.md) | | [optional]
**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional]


7 changes: 7 additions & 0 deletions docs/ErrorResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CyberSource.ErrorResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------


7 changes: 7 additions & 0 deletions docs/ErrorResponseWithHAL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CyberSource.ErrorResponseWithHAL

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------


7 changes: 7 additions & 0 deletions docs/ExistingInstrumentIdentifierId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CyberSource.ExistingInstrumentIdentifierId

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------


10 changes: 10 additions & 0 deletions docs/FileBean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.FileBean

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fileId** | **String** | Unique identifier for each file | [optional]
**href** | **String** | | [optional]
**method** | **String** | | [optional]


29 changes: 29 additions & 0 deletions docs/FileDetail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# CyberSource.FileDetail

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fileId** | **String** | Unique identifier of a file | [optional]
**name** | **String** | Name of the file | [optional]
**createdTime** | **Date** | Date and time for the file in PST | [optional]
**lastModifiedTime** | **Date** | Date and time for the file in PST | [optional]
**_date** | **Date** | Date and time for the file in PST | [optional]
**mimeType** | **String** | File extension | [optional]
**size** | **Number** | Size of the file in bytes | [optional]


<a name="MimeTypeEnum"></a>
## Enum: MimeTypeEnum


* `application/xml` (value: `"application/xml"`)

* `text/csv` (value: `"text/csv"`)

* `application/pdf` (value: `"application/pdf"`)

* `application/octet-stream` (value: `"application/octet-stream"`)




9 changes: 9 additions & 0 deletions docs/FileDetailsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.FileDetailsResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fileDetails** | [**[V1FileDetailsGet200ResponseFileDetails]**](V1FileDetailsGet200ResponseFileDetails.md) | | [optional]
**links** | [**V1FileDetailsGet200ResponseLinks**](V1FileDetailsGet200ResponseLinks.md) | | [optional]


8 changes: 8 additions & 0 deletions docs/Initiator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.Initiator

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**merchantInitiatedTransaction** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional]


10 changes: 0 additions & 10 deletions docs/InlineResponse200.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/InlineResponse200PaymentBatchSummaries.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/InstrumentIdentifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CyberSource.InstrumentIdentifier

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional]
**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional]
**_object** | **String** | Describes type of token. | [optional]
**state** | **String** | Current state of the token. | [optional]
**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional]
**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional]
**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional]
**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional]


<a name="ObjectEnum"></a>
## Enum: ObjectEnum


* `instrumentIdentifier` (value: `"instrumentIdentifier"`)




<a name="StateEnum"></a>
## Enum: StateEnum


* `ACTIVE` (value: `"ACTIVE"`)

* `CLOSED` (value: `"CLOSED"`)




4 changes: 2 additions & 2 deletions docs/InstrumentIdentifierApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**createInstrumentIdentifier**](InstrumentIdentifierApi.md#createInstrumentIdentifier) | **POST** /tms/v1/instrumentidentifiers | Create an Instrument Identifier
[**deleteInstrumentIdentifier**](InstrumentIdentifierApi.md#deleteInstrumentIdentifier) | **DELETE** /tms/v1/instrumentidentifiers/{tokenId} | Delete an Instrument Identifier
[**getAllPaymentInstruments**](InstrumentIdentifierApi.md#getAllPaymentInstruments) | **GET** /tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments | Retrieve all Payment Instruments associated with an Instrument Identifier
[**getAllPaymentInstruments**](InstrumentIdentifierApi.md#getAllPaymentInstruments) | **GET** /tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments | Retrieve all Payment Instruments
[**getInstrumentIdentifier**](InstrumentIdentifierApi.md#getInstrumentIdentifier) | **GET** /tms/v1/instrumentidentifiers/{tokenId} | Retrieve an Instrument Identifier
[**updateInstrumentIdentifier**](InstrumentIdentifierApi.md#updateInstrumentIdentifier) | **PATCH** /tms/v1/instrumentidentifiers/{tokenId} | Update a Instrument Identifier

Expand Down Expand Up @@ -109,7 +109,7 @@ No authorization required
# **getAllPaymentInstruments**
> TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response getAllPaymentInstruments(profileId, tokenId, opts)

Retrieve all Payment Instruments associated with an Instrument Identifier
Retrieve all Payment Instruments

### Example
```javascript
Expand Down
9 changes: 9 additions & 0 deletions docs/InstrumentIdentifierBankAccount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.InstrumentIdentifierBankAccount

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_number** | **String** | Checking account number. | [optional]
**routingNumber** | **String** | Routing number. | [optional]


8 changes: 8 additions & 0 deletions docs/InstrumentIdentifierCard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.InstrumentIdentifierCard

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_number** | **String** | Customer’s credit card number. | [optional]


Loading