@blockchyp/blockchyp-ts 2.22.0 → 2.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockchyp/blockchyp-ts",
-  "version": "2.22.0",
+  "version": "2.24.0",
   "description": "BlockChyp Typescript Client",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/models.ts

@@ -1879,6 +1879,16 @@ export class CustomerToken {
    */
     routingNumber: string | null = null;
 
+  /**
+   * Token hash (generated with a static salt, Merchant ID, Registration Date and PAN.
+   */
+    tokenHash: string | null = null;
+
+  /**
+   * Card bin.
+   */
+    bin: string | null = null;
+
   /**
    * Models customer records associated with a payment token.
    */
@@ -1895,6 +1905,8 @@ export class CustomerToken {
         accountHolderType: string | null = null,
         bankName: string | null = null,
         routingNumber: string | null = null,
+        tokenHash: string | null = null,
+        bin: string | null = null,
         customers: Customer[] | null = null,
         ) {
         this.token = token;
@@ -1906,6 +1918,8 @@ export class CustomerToken {
         this.accountHolderType = accountHolderType;
         this.bankName = bankName;
         this.routingNumber = routingNumber;
+        this.tokenHash = tokenHash;
+        this.bin = bin;
         this.customers = customers;
         }
 }
@@ -2980,6 +2994,11 @@ export class CardMetadataResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -3017,6 +3036,7 @@ export class CardMetadataResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -3037,6 +3057,7 @@ export class CardMetadataResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -3400,6 +3421,11 @@ export class BalanceResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -3446,6 +3472,7 @@ export class BalanceResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -3475,6 +3502,7 @@ export class BalanceResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -4214,6 +4242,11 @@ export class CaptureResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -4269,6 +4302,7 @@ export class CaptureResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -4311,6 +4345,7 @@ export class CaptureResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -4564,6 +4599,11 @@ export class VoidResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -4613,6 +4653,7 @@ export class VoidResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -4645,6 +4686,7 @@ export class VoidResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -5081,6 +5123,11 @@ export class EnrollResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -5121,6 +5168,17 @@ export class EnrollResponse {
    */
     bankName?: string;
 
+  /**
+   * The token hash (generated with a static salt, Merchant ID, Registration Date and
+   * PAN).
+   */
+    tokenHash?: string;
+
+  /**
+   * The first 8 digits of the card aka the BIN.
+   */
+    bin?: string;
+
     // Constructor with default values for optional fields
     constructor(
         success: boolean | null = null,
@@ -5150,6 +5208,7 @@ export class EnrollResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -5158,6 +5217,8 @@ export class EnrollResponse {
         accountType: string | undefined = undefined,
         accountHolderType: string | undefined = undefined,
         bankName: string | undefined = undefined,
+        tokenHash: string | undefined = undefined,
+        bin: string | undefined = undefined,
         ) {
         this.success = success;
         this.error = error;
@@ -5186,6 +5247,7 @@ export class EnrollResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -5194,6 +5256,8 @@ export class EnrollResponse {
         this.accountType = accountType;
         this.accountHolderType = accountHolderType;
         this.bankName = bankName;
+        this.tokenHash = tokenHash;
+        this.bin = bin;
         }
 }
 
@@ -6338,6 +6402,11 @@ export class AuthorizationResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -6429,6 +6498,7 @@ export class AuthorizationResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -6486,6 +6556,7 @@ export class AuthorizationResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -7027,6 +7098,11 @@ export class TransactionStatus {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -7092,6 +7168,7 @@ export class TransactionStatus {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -7136,6 +7213,7 @@ export class TransactionStatus {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
@@ -10015,6 +10093,32 @@ export class MerchantProfile {
    */
     passthroughSurchargeEnabled: boolean | null = null;
 
+  /**
+   * That CVV verification is enabled for manually entered transactions.
+   */
+    cvvVerificationEnabled: boolean | null = null;
+
+  /**
+   * That CVV mismatch (N) responses should be declined.
+   */
+    cvvVerificationNEnabled: boolean | null = null;
+
+  /**
+   * That CVV not processed (P) responses should be declined.
+   */
+    cvvVerificationPEnabled: boolean | null = null;
+
+  /**
+   * That CVV should be on card but is not indicated (S) responses should be declined.
+   */
+    cvvVerificationSEnabled: boolean | null = null;
+
+  /**
+   * That issuer not certified or has not provided encryption key (U) responses should be
+   * declined.
+   */
+    cvvVerificationUEnabled: boolean | null = null;
+
     // Constructor with default values for optional fields
     constructor(
         timeout: number | null = null,
@@ -10071,6 +10175,11 @@ export class MerchantProfile {
         gatewayOnly: boolean | null = null,
         bankAccounts: BankAccount[] | null = null,
         passthroughSurchargeEnabled: boolean | null = null,
+        cvvVerificationEnabled: boolean | null = null,
+        cvvVerificationNEnabled: boolean | null = null,
+        cvvVerificationPEnabled: boolean | null = null,
+        cvvVerificationSEnabled: boolean | null = null,
+        cvvVerificationUEnabled: boolean | null = null,
         ) {
         this.timeout = timeout;
         this.test = test;
@@ -10126,6 +10235,11 @@ export class MerchantProfile {
         this.gatewayOnly = gatewayOnly;
         this.bankAccounts = bankAccounts;
         this.passthroughSurchargeEnabled = passthroughSurchargeEnabled;
+        this.cvvVerificationEnabled = cvvVerificationEnabled;
+        this.cvvVerificationNEnabled = cvvVerificationNEnabled;
+        this.cvvVerificationPEnabled = cvvVerificationPEnabled;
+        this.cvvVerificationSEnabled = cvvVerificationSEnabled;
+        this.cvvVerificationUEnabled = cvvVerificationUEnabled;
         }
 }
 
@@ -10418,6 +10532,32 @@ export class MerchantProfileResponse {
    */
     passthroughSurchargeEnabled: boolean | null = null;
 
+  /**
+   * That CVV verification is enabled for manually entered transactions.
+   */
+    cvvVerificationEnabled: boolean | null = null;
+
+  /**
+   * That CVV mismatch (N) responses should be declined.
+   */
+    cvvVerificationNEnabled: boolean | null = null;
+
+  /**
+   * That CVV not processed (P) responses should be declined.
+   */
+    cvvVerificationPEnabled: boolean | null = null;
+
+  /**
+   * That CVV should be on card but is not indicated (S) responses should be declined.
+   */
+    cvvVerificationSEnabled: boolean | null = null;
+
+  /**
+   * That issuer not certified or has not provided encryption key (U) responses should be
+   * declined.
+   */
+    cvvVerificationUEnabled: boolean | null = null;
+
     // Constructor with default values for optional fields
     constructor(
         success: boolean | null = null,
@@ -10476,6 +10616,11 @@ export class MerchantProfileResponse {
         gatewayOnly: boolean | null = null,
         bankAccounts: BankAccount[] | null = null,
         passthroughSurchargeEnabled: boolean | null = null,
+        cvvVerificationEnabled: boolean | null = null,
+        cvvVerificationNEnabled: boolean | null = null,
+        cvvVerificationPEnabled: boolean | null = null,
+        cvvVerificationSEnabled: boolean | null = null,
+        cvvVerificationUEnabled: boolean | null = null,
         ) {
         this.success = success;
         this.error = error;
@@ -10533,6 +10678,11 @@ export class MerchantProfileResponse {
         this.gatewayOnly = gatewayOnly;
         this.bankAccounts = bankAccounts;
         this.passthroughSurchargeEnabled = passthroughSurchargeEnabled;
+        this.cvvVerificationEnabled = cvvVerificationEnabled;
+        this.cvvVerificationNEnabled = cvvVerificationNEnabled;
+        this.cvvVerificationPEnabled = cvvVerificationPEnabled;
+        this.cvvVerificationSEnabled = cvvVerificationSEnabled;
+        this.cvvVerificationUEnabled = cvvVerificationUEnabled;
         }
 }
 
@@ -17653,6 +17803,11 @@ export class PaymentMethodResponse {
    */
     avsResponse: AVSResponse | null = null;
 
+  /**
+   * The CVV verification result if CVV was submitted.
+   */
+    cvvResponse?: string;
+
   /**
    * Suggested receipt fields.
    */
@@ -17681,6 +17836,7 @@ export class PaymentMethodResponse {
         expMonth: string | undefined = undefined,
         expYear: string | undefined = undefined,
         avsResponse: AVSResponse | null = null,
+        cvvResponse: string | undefined = undefined,
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
@@ -17697,6 +17853,7 @@ export class PaymentMethodResponse {
         this.expMonth = expMonth;
         this.expYear = expYear;
         this.avsResponse = avsResponse;
+        this.cvvResponse = cvvResponse;
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;