Skip to content

Commit 75335be

Browse files
gnongsiegnongsie
authored
Merge pull request #21 from CyberSource/payer-auth
Payer auth API changes
2 parents 6ad5224 + d4edb21 commit 75335be

File tree

664 files changed

+36826
-13203
lines changed

Some content is hidden

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

664 files changed

+36826
-13203
lines changed

‎docs/AuthorizationOptions.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.AuthorizationOptions
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**initiator** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.md) | | [optional]
7+
8+

‎docs/BillTo.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CyberSource.BillTo
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**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]
7+
**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]
8+
**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]
9+
**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]
10+
**address2** | **String** | Additional address information. | [optional]
11+
**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]
12+
**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]
13+
**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]
14+
**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]
15+
**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]
16+
**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]
17+
18+

‎docs/BuyerInformation.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource.BuyerInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**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]
7+
**currency** | **String** | Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha. | [optional]
8+
**dateOBirth** | **String** | Date of birth of the customer. Format: `YYYY-MM-DD` or `YYYYMMDD` | [optional]
9+
**personalIdentification** | [**[TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification]**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.md) | | [optional]
10+
11+

‎docs/CardInfo.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource.CardInfo
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**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. |
7+
**cardExpirationMonth** | **String** | Two digit expiration month | [optional]
8+
**cardExpirationYear** | **String** | Four digit expiration year | [optional]
9+
**cardType** | **String** | Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. |
10+
11+

‎docs/CheckPayerAuthEnrollmentRequest.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CyberSource.CheckPayerAuthEnrollmentRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientReferenceInformation** | [**Riskv1authenticationsClientReferenceInformation**](Riskv1authenticationsClientReferenceInformation.md) | | [optional]
7+
**orderInformation** | [**Riskv1authenticationsOrderInformation**](Riskv1authenticationsOrderInformation.md) | | [optional]
8+
**paymentInformation** | [**Riskv1authenticationsPaymentInformation**](Riskv1authenticationsPaymentInformation.md) | | [optional]
9+
**buyerInformation** | [**Riskv1authenticationsBuyerInformation**](Riskv1authenticationsBuyerInformation.md) | | [optional]
10+
**deviceInformation** | [**Riskv1authenticationsDeviceInformation**](Riskv1authenticationsDeviceInformation.md) | | [optional]
11+
**merchantInformation** | [**Riskv1authenticationsMerchantInformation**](Riskv1authenticationsMerchantInformation.md) | | [optional]
12+
**recurringPaymentInformation** | [**Riskv1authenticationsRecurringPaymentInformation**](Riskv1authenticationsRecurringPaymentInformation.md) | | [optional]
13+
**consumerAuthenticationInformation** | [**Riskv1authenticationsConsumerAuthenticationInformation**](Riskv1authenticationsConsumerAuthenticationInformation.md) | | [optional]
14+
**riskInformation** | [**Riskv1authenticationsRiskInformation**](Riskv1authenticationsRiskInformation.md) | | [optional]
15+
**travelInformation** | [**Riskv1authenticationsTravelInformation**](Riskv1authenticationsTravelInformation.md) | | [optional]
16+
**merchantDefinedInformation** | [**[Riskv1decisionsMerchantDefinedInformation]**](Riskv1decisionsMerchantDefinedInformation.md) | | [optional]
17+
18+

‎docs/DerPublicKey.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.DerPublicKey
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**format** | **String** | Specifies the format of the public key; currently X.509. | [optional]
7+
**algorithm** | **String** | Algorithm used to encrypt the public key. | [optional]
8+
**publicKey** | **String** | Base64 encoded public key value. | [optional]
9+
10+

‎docs/Detail.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.Detail
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | The name of the field that threw the error. | [optional]
7+
**location** | **String** | The location of the field that threw the error. | [optional]
8+
9+

‎docs/EmbeddedInstrumentIdentifier.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# CyberSource.EmbeddedInstrumentIdentifier
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional]
7+
**_object** | **String** | Describes type of token. | [optional]
8+
**state** | **String** | Current state of the token. | [optional]
9+
**id** | **String** | The ID of the existing instrument identifier to be linked to the newly created payment instrument. | [optional]
10+
**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional]
11+
**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional]
12+
**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional]
13+
**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional]
14+
15+
16+
<a name="ObjectEnum"></a>
17+
## Enum: ObjectEnum
18+
19+
20+
* `instrumentIdentifier` (value: `"instrumentIdentifier"`)
21+
22+
23+
24+
25+
<a name="StateEnum"></a>
26+
## Enum: StateEnum
27+
28+
29+
* `ACTIVE` (value: `"ACTIVE"`)
30+
31+
* `CLOSED` (value: `"CLOSED"`)
32+
33+
34+
35+

‎docs/Error.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.Error
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**type** | **String** | | [optional]
7+
**message** | **String** | The detailed message related to the type stated above. | [optional]
8+
**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional]
9+
10+

‎docs/ErrorBean.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CyberSource.ErrorBean
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**code** | **String** | Error code |
7+
**message** | **String** | Error message |
8+
**localizationKey** | **String** | Localization Key Name | [optional]
9+
**correlationId** | **String** | Correlation Id | [optional]
10+
**detail** | **String** | Error Detail | [optional]
11+
**fields** | [**[InlineResponse400Fields]**](InlineResponse400Fields.md) | Error fields List | [optional]
12+
13+

‎docs/ErrorFieldBean.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.ErrorFieldBean
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**path** | **String** | Path of the failed property | [optional]
7+
**message** | **String** | Error description about validation failed field | [optional]
8+
**localizationKey** | **String** | Localized Key Name | [optional]
9+
10+

‎docs/ErrorLinks.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.ErrorLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**next** | [**[InlineResponseDefaultLinksNext]**](InlineResponseDefaultLinksNext.md) | | [optional]
7+
**documentation** | [**[InlineResponseDefaultLinksNext]**](InlineResponseDefaultLinksNext.md) | | [optional]
8+
**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional]
9+
10+

‎docs/ErrorResponse.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CyberSource.ErrorResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+

‎docs/ErrorResponseWithHAL.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CyberSource.ErrorResponseWithHAL
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+

‎docs/ExistingInstrumentIdentifierId.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CyberSource.ExistingInstrumentIdentifierId
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+

‎docs/FileBean.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.FileBean
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**fileId** | **String** | Unique identifier for each file | [optional]
7+
**href** | **String** | | [optional]
8+
**method** | **String** | | [optional]
9+
10+

‎docs/FileDetail.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# CyberSource.FileDetail
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**fileId** | **String** | Unique identifier of a file | [optional]
7+
**name** | **String** | Name of the file | [optional]
8+
**createdTime** | **Date** | Date and time for the file in PST | [optional]
9+
**lastModifiedTime** | **Date** | Date and time for the file in PST | [optional]
10+
**_date** | **Date** | Date and time for the file in PST | [optional]
11+
**mimeType** | **String** | File extension | [optional]
12+
**size** | **Number** | Size of the file in bytes | [optional]
13+
14+
15+
<a name="MimeTypeEnum"></a>
16+
## Enum: MimeTypeEnum
17+
18+
19+
* `application/xml` (value: `"application/xml"`)
20+
21+
* `text/csv` (value: `"text/csv"`)
22+
23+
* `application/pdf` (value: `"application/pdf"`)
24+
25+
* `application/octet-stream` (value: `"application/octet-stream"`)
26+
27+
28+
29+

‎docs/FileDetailsResponse.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.FileDetailsResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**fileDetails** | [**[V1FileDetailsGet200ResponseFileDetails]**](V1FileDetailsGet200ResponseFileDetails.md) | | [optional]
7+
**links** | [**V1FileDetailsGet200ResponseLinks**](V1FileDetailsGet200ResponseLinks.md) | | [optional]
8+
9+

‎docs/Initiator.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.Initiator
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**merchantInitiatedTransaction** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional]
7+
8+

‎docs/InlineResponse200.md

-10
This file was deleted.

‎docs/InlineResponse200PaymentBatchSummaries.md

-19
This file was deleted.

‎docs/InstrumentIdentifier.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# CyberSource.InstrumentIdentifier
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional]
7+
**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional]
8+
**_object** | **String** | Describes type of token. | [optional]
9+
**state** | **String** | Current state of the token. | [optional]
10+
**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional]
11+
**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional]
12+
**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional]
13+
**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional]
14+
15+
16+
<a name="ObjectEnum"></a>
17+
## Enum: ObjectEnum
18+
19+
20+
* `instrumentIdentifier` (value: `"instrumentIdentifier"`)
21+
22+
23+
24+
25+
<a name="StateEnum"></a>
26+
## Enum: StateEnum
27+
28+
29+
* `ACTIVE` (value: `"ACTIVE"`)
30+
31+
* `CLOSED` (value: `"CLOSED"`)
32+
33+
34+
35+

‎docs/InstrumentIdentifierApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**createInstrumentIdentifier**](InstrumentIdentifierApi.md#createInstrumentIdentifier) | **POST** /tms/v1/instrumentidentifiers | Create an Instrument Identifier
88
[**deleteInstrumentIdentifier**](InstrumentIdentifierApi.md#deleteInstrumentIdentifier) | **DELETE** /tms/v1/instrumentidentifiers/{tokenId} | Delete an Instrument Identifier
9-
[**getAllPaymentInstruments**](InstrumentIdentifierApi.md#getAllPaymentInstruments) | **GET** /tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments | Retrieve all Payment Instruments associated with an Instrument Identifier
9+
[**getAllPaymentInstruments**](InstrumentIdentifierApi.md#getAllPaymentInstruments) | **GET** /tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments | Retrieve all Payment Instruments
1010
[**getInstrumentIdentifier**](InstrumentIdentifierApi.md#getInstrumentIdentifier) | **GET** /tms/v1/instrumentidentifiers/{tokenId} | Retrieve an Instrument Identifier
1111
[**updateInstrumentIdentifier**](InstrumentIdentifierApi.md#updateInstrumentIdentifier) | **PATCH** /tms/v1/instrumentidentifiers/{tokenId} | Update a Instrument Identifier
1212

@@ -109,7 +109,7 @@ No authorization required
109109
# **getAllPaymentInstruments**
110110
> TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response getAllPaymentInstruments(profileId, tokenId, opts)
111111
112-
Retrieve all Payment Instruments associated with an Instrument Identifier
112+
Retrieve all Payment Instruments
113113

114114
### Example
115115
```javascript

‎docs/InstrumentIdentifierBankAccount.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.InstrumentIdentifierBankAccount
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**_number** | **String** | Checking account number. | [optional]
7+
**routingNumber** | **String** | Routing number. | [optional]
8+
9+

‎docs/InstrumentIdentifierCard.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.InstrumentIdentifierCard
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**_number** | **String** | Customer’s credit card number. | [optional]
7+
8+

0 commit comments

Comments
 (0)