Skip to content

Commit 78f4aa6

Browse files
gaubansagaubansa
authored
Merge pull request #146 from CyberSource/july24-release
july spec changes
2 parents 89adb5f + 345e224 commit 78f4aa6

File tree

333 files changed

+6929
-2063
lines changed

Some content is hidden

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

333 files changed

+6929
-2063
lines changed

‎docs/BinLookupApi.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# CyberSource.BinLookupApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getAccountInfo**](BinLookupApi.md#getAccountInfo) | **POST** /bin/v1/binlookup | BIN Lookup API
8+
9+
10+
<a name="getAccountInfo"></a>
11+
# **getAccountInfo**
12+
> InlineResponse2011 getAccountInfo(createBinLookupRequest)
13+
14+
BIN Lookup API
15+
16+
The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.BinLookupApi();
23+
24+
var createBinLookupRequest = new CyberSource.CreateBinLookupRequest(); // CreateBinLookupRequest |
25+
26+
27+
var callback = function(error, data, response) {
28+
if (error) {
29+
console.error(error);
30+
} else {
31+
console.log('API called successfully. Returned data: ' + data);
32+
}
33+
};
34+
apiInstance.getAccountInfo(createBinLookupRequest, callback);
35+
```
36+
37+
### Parameters
38+
39+
Name | Type | Description | Notes
40+
------------- | ------------- | ------------- | -------------
41+
**createBinLookupRequest** | [**CreateBinLookupRequest**](CreateBinLookupRequest.md)| |
42+
43+
### Return type
44+
45+
[**InlineResponse2011**](InlineResponse2011.md)
46+
47+
### Authorization
48+
49+
No authorization required
50+
51+
### HTTP request headers
52+
53+
- **Content-Type**: application/json;charset=utf-8
54+
- **Accept**: application/hal+json;charset=utf-8
55+

‎docs/TssV2TransactionsPost400Response.md ‎docs/BinLookupv400Response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CyberSource.TssV2TransactionsPost400Response
1+
# CyberSource.BinLookupv400Response
22

33
## Properties
44
Name | Type | Description | Notes

‎docs/Binv1binlookupClientReferenceInformation.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource.Binv1binlookupClientReferenceInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional]
7+
**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]
8+
**applicationVersion** | **String** | Version of the CyberSource application or integration used for a transaction. | [optional]
9+
**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]
10+
11+

‎docs/Binv1binlookupPaymentInformation.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource.Binv1binlookupPaymentInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**card** | [**Binv1binlookupPaymentInformationCard**](Binv1binlookupPaymentInformationCard.md) | | [optional]
7+
**customer** | [**GetAllSubscriptionsResponsePaymentInformationCustomer**](GetAllSubscriptionsResponsePaymentInformationCustomer.md) | | [optional]
8+
**paymentInstrument** | [**Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) | | [optional]
9+
**instrumentIdentifier** | [**Ptsv2paymentsPaymentInformationInstrumentIdentifier**](Ptsv2paymentsPaymentInformationInstrumentIdentifier.md) | | [optional]
10+
11+

‎docs/Binv1binlookupPaymentInformationCard.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.Binv1binlookupPaymentInformationCard
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**_number** | **String** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
7+
8+

‎docs/Binv1binlookupProcessingInformation.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.Binv1binlookupProcessingInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional]
7+
**payoutOptions** | [**Binv1binlookupProcessingInformationPayoutOptions**](Binv1binlookupProcessingInformationPayoutOptions.md) | | [optional]
8+
9+

‎docs/Binv1binlookupProcessingInformationPayoutOptions.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.Binv1binlookupProcessingInformationPayoutOptions
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**payoutInquiry** | **Boolean** | If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - true - false | [optional]
7+
**networkId** | **String** | The networks specified in this field must be a subset of the information provided during program enrollment Possible values: - 0020 : Accel/Exchange - 0024 : CU24 - 0003 : Interlink - 0016 : Maestro - 0018 : NYCE - 0027 : NYCE - 0009 : Pulse - 0017 : Pulse - 0019 : Pulse - 0008 : Star - 0010 : Star - 0011 : Star - 0012 : Star - 0015 : Star - 0002 : Visa/PLUS | [optional]
8+
**acquirerBin** | **String** | BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment. | [optional]
9+
10+

‎docs/Binv1binlookupTokenInformation.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.Binv1binlookupTokenInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**jti** | **String** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional]
7+
**transientTokenJwt** | **String** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. | [optional]
8+
9+

‎docs/CreateBinLookupRequest.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CyberSource.CreateBinLookupRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientReferenceInformation** | [**Binv1binlookupClientReferenceInformation**](Binv1binlookupClientReferenceInformation.md) | | [optional]
7+
**paymentInformation** | [**Binv1binlookupPaymentInformation**](Binv1binlookupPaymentInformation.md) | | [optional]
8+
**tokenInformation** | [**Binv1binlookupTokenInformation**](Binv1binlookupTokenInformation.md) | | [optional]
9+
**processingInformation** | [**Binv1binlookupProcessingInformation**](Binv1binlookupProcessingInformation.md) | | [optional]
10+
11+

‎docs/CreateNewWebhooksApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Method | HTTP request | Description
1111

1212
<a name="createWebhookSubscription"></a>
1313
# **createWebhookSubscription**
14-
> InlineResponse2013 createWebhookSubscription(opts)
14+
> InlineResponse2014 createWebhookSubscription(opts)
1515
1616
Create a Webhook
1717

@@ -45,7 +45,7 @@ Name | Type | Description | Notes
4545

4646
### Return type
4747

48-
[**InlineResponse2013**](InlineResponse2013.md)
48+
[**InlineResponse2014**](InlineResponse2014.md)
4949

5050
### Authorization
5151

@@ -104,7 +104,7 @@ No authorization required
104104

105105
<a name="saveSymEgressKey"></a>
106106
# **saveSymEgressKey**
107-
> InlineResponse2012 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, opts)
107+
> InlineResponse2013 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, opts)
108108
109109
Create Webhook Security Keys
110110

@@ -146,7 +146,7 @@ Name | Type | Description | Notes
146146

147147
### Return type
148148

149-
[**InlineResponse2012**](InlineResponse2012.md)
149+
[**InlineResponse2013**](InlineResponse2013.md)
150150

151151
### Authorization
152152

‎docs/InlineResponse2002.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**integrationInformation** | [**InlineResponse2002IntegrationInformation**](InlineResponse2002IntegrationInformation.md) | | [optional]
88
**organizationInformation** | [**Boardingv1registrationsOrganizationInformation**](Boardingv1registrationsOrganizationInformation.md) | | [optional]
99
**productInformation** | [**Boardingv1registrationsProductInformation**](Boardingv1registrationsProductInformation.md) | | [optional]
10-
**productInformationSetups** | [**[InlineResponse2011ProductInformationSetups]**](InlineResponse2011ProductInformationSetups.md) | | [optional]
10+
**productInformationSetups** | [**[InlineResponse2012ProductInformationSetups]**](InlineResponse2012ProductInformationSetups.md) | | [optional]
1111
**documentInformation** | [**Boardingv1registrationsDocumentInformation**](Boardingv1registrationsDocumentInformation.md) | | [optional]
1212
**details** | **{String: [Object]}** | | [optional]
1313

‎docs/InlineResponse2011.md

+6-28
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,11 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **String** | | [optional]
7-
**submitTimeUtc** | **Date** | 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. | [optional]
8-
**status** | **String** | The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' | [optional]
9-
**registrationInformation** | [**InlineResponse2011RegistrationInformation**](InlineResponse2011RegistrationInformation.md) | | [optional]
10-
**integrationInformation** | [**InlineResponse2011IntegrationInformation**](InlineResponse2011IntegrationInformation.md) | | [optional]
11-
**organizationInformation** | [**InlineResponse2011OrganizationInformation**](InlineResponse2011OrganizationInformation.md) | | [optional]
12-
**productInformationSetups** | [**[InlineResponse2011ProductInformationSetups]**](InlineResponse2011ProductInformationSetups.md) | | [optional]
13-
**message** | **String** | | [optional]
14-
**details** | **{String: [Object]}** | | [optional]
15-
16-
17-
<a name="StatusEnum"></a>
18-
## Enum: StatusEnum
19-
20-
21-
* `INITIALIZED` (value: `"INITIALIZED"`)
22-
23-
* `RECEIVED` (value: `"RECEIVED"`)
24-
25-
* `PROCESSING` (value: `"PROCESSING"`)
26-
27-
* `SUCCESS` (value: `"SUCCESS"`)
28-
29-
* `FAILURE` (value: `"FAILURE"`)
30-
31-
* `PARTIAL` (value: `"PARTIAL"`)
32-
33-
6+
**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]
7+
**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]
8+
**status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional]
9+
**paymentAccountInformation** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional]
10+
**issuerInformation** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional]
11+
**payoutInformation** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional]
3412

3513

‎docs/InlineResponse2011IssuerInformation.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CyberSource.InlineResponse2011IssuerInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | This field contains the issuer name. | [optional]
7+
**country** | **String** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional]
8+
**binLength** | **String** | This field contains the length of the BIN. | [optional]
9+
**accountPrefix** | **String** | 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). | [optional]
10+
**phoneNumber** | **String** | This field contains the customer service phone number for the issuer. | [optional]
11+
12+

‎docs/InlineResponse2011PaymentAccountInformation.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CyberSource.InlineResponse2011PaymentAccountInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**card** | [**InlineResponse2011PaymentAccountInformationCard**](InlineResponse2011PaymentAccountInformationCard.md) | | [optional]
7+
**features** | [**InlineResponse2011PaymentAccountInformationFeatures**](InlineResponse2011PaymentAccountInformationFeatures.md) | | [optional]
8+
**network** | [**InlineResponse2011PaymentAccountInformationNetwork**](InlineResponse2011PaymentAccountInformationNetwork.md) | | [optional]
9+
10+

‎docs/InlineResponse2011PaymentAccountInformationCard.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CyberSource.InlineResponse2011PaymentAccountInformationCard
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**type** | **String** | This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. | [optional]
7+
**brandName** | **String** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional]
8+
**currency** | **String** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional]
9+
**maxLength** | **String** | This field contains the max length of the card. | [optional]
10+
**credentialType** | **String** | This field contains the type of the payment credential. Possible values: - PAN - TOKEN | [optional]
11+
**brands** | [**[InlineResponse2011PaymentAccountInformationCardBrands]**](InlineResponse2011PaymentAccountInformationCardBrands.md) | Array of brands | [optional]
12+
13+

0 commit comments

Comments
 (0)