wp-apimatic 1.0.2

package/src/models/transactionAmountRange.ts

@@ -0,0 +1,37 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  number,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface TransactionAmountRange {
+  /** The lowest transaction value in the search range. */
+  fromAmount?: number;
+  /** The highest transaction value in the search range. */
+  toAmount?: number;
+  /** The alpha codes and numeric codes for the representation of currencies and provides information about the relationships between individual currencies and their minor units. ISO Standard country code for United States. <br> Applicable for credit and gift cards. */
+  authorizationCurrencyCode?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const transactionAmountRangeSchema: Schema<TransactionAmountRange> = typedExpandoObject(
+  {
+    fromAmount: ['fromAmount', optional(number())],
+    toAmount: ['toAmount', optional(number())],
+    authorizationCurrencyCode: [
+      'authorizationCurrencyCode',
+      optional(string()),
+    ],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/transactionDetails.ts

@@ -0,0 +1,247 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  lazy,
+  number,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  AccountNameInquiry,
+  accountNameInquirySchema,
+} from './accountNameInquiry.js';
+import { Aci, aciSchema } from './aci.js';
+import {
+  AuthorizationCurrency,
+  authorizationCurrencySchema,
+} from './authorizationCurrency.js';
+import {
+  AuthorizationSource,
+  authorizationSourceSchema,
+} from './authorizationSource.js';
+import { AvsResponseCode, avsResponseCodeSchema } from './avsResponseCode.js';
+import { CardholderId, cardholderIdSchema } from './cardholderId.js';
+import {
+  CodeAndDescription,
+  codeAndDescriptionSchema,
+} from './codeAndDescription.js';
+import { EntryMode, entryModeSchema } from './entryMode.js';
+import {
+  MailPhoneIndicator,
+  mailPhoneIndicatorSchema,
+} from './mailPhoneIndicator.js';
+import { NetworkGroup, networkGroupSchema } from './networkGroup.js';
+import { OriginType, originTypeSchema } from './originType.js';
+import { PinLess, pinLessSchema } from './pinLess.js';
+import {
+  PosConditionCode,
+  posConditionCodeSchema,
+} from './posConditionCode.js';
+import {
+  TerminalCapability,
+  terminalCapabilitySchema,
+} from './terminalCapability.js';
+import {
+  TransactionStatus,
+  transactionStatusSchema,
+} from './transactionStatus.js';
+import { TransactionType, transactionTypeSchema } from './transactionType.js';
+
+/** Provides transaction amount related information. */
+export interface TransactionDetails {
+  /** The unique 12-19 digit identifier that is generated with every card transaction and from the electronic transfer of funds. */
+  transactionId?: string;
+  /** Refers to the date when the transaction has been processed for settlement between the two parties. */
+  processDate?: string;
+  /** Refers to the date and time when the bank has settled the transaction (deposits or withdraws funds). */
+  transactionDateTime?: string;
+  /** The approved amount of money to be charged. */
+  authorizationAmount?: number;
+  /** The agreed upon sum for a transaction after authorization and processing steps. */
+  approvedAmount?: number;
+  /** The six number code from the issuing bank to the vendor that authorizes the sale. */
+  authorizationCode?: string;
+  authorizationCurrency?: AuthorizationCurrency;
+  authorizationSource?: AuthorizationSource;
+  transactionType?: TransactionType;
+  transactionStatus?: TransactionStatus;
+  entryMode?: EntryMode;
+  avsResponseCode?: AvsResponseCode;
+  cardholderId?: CardholderId;
+  /** Te unique order identifier indicating the transaction or event sequence. */
+  sequenceNumber?: string;
+  /** The ecommerce authorization identifier. */
+  authorizationIdentifier?: string;
+  /** The unique identifier of the purchaser associated with the transaction. */
+  customerIdentifier?: string;
+  /** The merchant-designated identifier for this transaction. */
+  merchantOrderIdentifier?: string;
+  /** The merchant-specified identifier used to track transactions associated with specific marketing campaigns. */
+  campaign?: string;
+  /** The merchant-specified identifier used to track transactions associated with your affiliate organizations. */
+  affiliate?: string;
+  /** The merchant-specified identifier for grouping transactions by an additional transaction level id outside of affiliate or campaign. */
+  merchantGroupingIdentifier?: string;
+  /** The reporting group category to which the transaction belongs. */
+  reportGroup?: string;
+  aci?: Aci;
+  mailPhoneIndicator?: MailPhoneIndicator;
+  originType?: OriginType;
+  /** The validation code for Visa card network transactions. */
+  validationCode?: string;
+  /** The unique identifier assigned to a point-of-sale terminal for tracking transactions and managing sales data. */
+  posRegisterNumber?: string;
+  /** The eight-digit sequence of characters used by financial institutions to monitor which terminal is used to process a transaction. */
+  terminalNumber?: string;
+  /** The key to uniquely identify a card transaction based on the ISO 8583 standard. */
+  referenceNumber?: string;
+  /** The merchant reference or draft locator number. */
+  draftLocator?: string;
+  terminalCapability?: TerminalCapability;
+  /** The date when funds or securities are delivered to complete the transaction. */
+  arrivalDate?: string;
+  /** The classification of the transaction processing method for financial reconciliation. */
+  settlementType?: string;
+  /** Process of converting debit card transactions to signature based transactions. Possible values are True or False. */
+  signatureDebitConversion?: boolean;
+  /** The unique 15-digit identification number for the terminal. */
+  terminalId?: string;
+  /** The location identifier or address for the physical point-of-sale device or processing equipment. */
+  terminalAddress?: string;
+  /** The city where the physical point-of-sale device or processing equipment is located. */
+  terminalCity?: string;
+  /** The state where the physical point-of-sale device or processing equipment is located. */
+  terminalState?: string;
+  /** Mechanism to resolve disputes or conflicts in settlements. */
+  tieBreaker?: string;
+  /** The amount of the previous transaction a merchant submitted to the customer's issuing bank for approval. */
+  oldAuthorizationAmount?: number;
+  /** The 11-byte unique identifier assigned to a group of transactions that were handled together as a single unit. */
+  batchNumber?: number;
+  /** The amount refunded to the cardholder's account that is a small percentage of the sum spent on purchases. */
+  cashbackAmount?: number;
+  /** The additional amount given in appreciation for a service. */
+  gratuityAmount?: number;
+  /** Indicates network id */
+  networkId?: string;
+  networkGroup?: NetworkGroup;
+  /** The initial justification for reauthorizing a transaction. */
+  originalReAuthorizationReason?: string;
+  /** The unique reference number associated with a voucher. */
+  voucherNumber?: string;
+  posConditionCode?: PosConditionCode;
+  /** The unique identifier and the brief description. */
+  toAccountType?: CodeAndDescription;
+  /** The unique identifier and the brief description. */
+  fromAccountType?: CodeAndDescription;
+  /** The amount still owed after a payment. */
+  remainingBalance?: number;
+  /** If a financial transaction is completed and settled. */
+  settled?: boolean;
+  pinLess?: PinLess;
+  accountNameInquiry?: AccountNameInquiry;
+  /** The unique identifier associated with a specific transaction that helps in tracking and reconciling payments across different systems. */
+  mastercardTransactionLinkId?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const transactionDetailsSchema: Schema<TransactionDetails> = lazy(() =>
+  typedExpandoObject(
+    {
+      transactionId: ['transactionId', optional(string())],
+      processDate: ['processDate', optional(string())],
+      transactionDateTime: ['transactionDateTime', optional(string())],
+      authorizationAmount: ['authorizationAmount', optional(number())],
+      approvedAmount: ['approvedAmount', optional(number())],
+      authorizationCode: ['authorizationCode', optional(string())],
+      authorizationCurrency: [
+        'authorizationCurrency',
+        optional(authorizationCurrencySchema),
+      ],
+      authorizationSource: [
+        'authorizationSource',
+        optional(authorizationSourceSchema),
+      ],
+      transactionType: ['transactionType', optional(transactionTypeSchema)],
+      transactionStatus: [
+        'transactionStatus',
+        optional(transactionStatusSchema),
+      ],
+      entryMode: ['entryMode', optional(entryModeSchema)],
+      avsResponseCode: ['avsResponseCode', optional(avsResponseCodeSchema)],
+      cardholderId: ['cardholderId', optional(cardholderIdSchema)],
+      sequenceNumber: ['sequenceNumber', optional(string())],
+      authorizationIdentifier: ['authorizationIdentifier', optional(string())],
+      customerIdentifier: ['customerIdentifier', optional(string())],
+      merchantOrderIdentifier: ['merchantOrderIdentifier', optional(string())],
+      campaign: ['campaign', optional(string())],
+      affiliate: ['affiliate', optional(string())],
+      merchantGroupingIdentifier: [
+        'merchantGroupingIdentifier',
+        optional(string()),
+      ],
+      reportGroup: ['reportGroup', optional(string())],
+      aci: ['aci', optional(aciSchema)],
+      mailPhoneIndicator: [
+        'mailPhoneIndicator',
+        optional(mailPhoneIndicatorSchema),
+      ],
+      originType: ['originType', optional(originTypeSchema)],
+      validationCode: ['validationCode', optional(string())],
+      posRegisterNumber: ['posRegisterNumber', optional(string())],
+      terminalNumber: ['terminalNumber', optional(string())],
+      referenceNumber: ['referenceNumber', optional(string())],
+      draftLocator: ['draftLocator', optional(string())],
+      terminalCapability: [
+        'terminalCapability',
+        optional(terminalCapabilitySchema),
+      ],
+      arrivalDate: ['arrivalDate', optional(string())],
+      settlementType: ['settlementType', optional(string())],
+      signatureDebitConversion: [
+        'signatureDebitConversion',
+        optional(boolean()),
+      ],
+      terminalId: ['terminalId', optional(string())],
+      terminalAddress: ['terminalAddress', optional(string())],
+      terminalCity: ['terminalCity', optional(string())],
+      terminalState: ['terminalState', optional(string())],
+      tieBreaker: ['tieBreaker', optional(string())],
+      oldAuthorizationAmount: ['oldAuthorizationAmount', optional(number())],
+      batchNumber: ['batchNumber', optional(number())],
+      cashbackAmount: ['cashbackAmount', optional(number())],
+      gratuityAmount: ['gratuityAmount', optional(number())],
+      networkId: ['networkId', optional(string())],
+      networkGroup: ['networkGroup', optional(networkGroupSchema)],
+      originalReAuthorizationReason: [
+        'originalReAuthorizationReason',
+        optional(string()),
+      ],
+      voucherNumber: ['voucherNumber', optional(string())],
+      posConditionCode: ['posConditionCode', optional(posConditionCodeSchema)],
+      toAccountType: ['toAccountType', optional(codeAndDescriptionSchema)],
+      fromAccountType: ['fromAccountType', optional(codeAndDescriptionSchema)],
+      remainingBalance: ['remainingBalance', optional(number())],
+      settled: ['settled', optional(boolean())],
+      pinLess: ['pinLess', optional(pinLessSchema)],
+      accountNameInquiry: [
+        'accountNameInquiry',
+        optional(accountNameInquirySchema),
+      ],
+      mastercardTransactionLinkId: [
+        'mastercardTransactionLinkID',
+        optional(string()),
+      ],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/transactionDetails2.ts

@@ -0,0 +1,246 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  lazy,
+  number,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  AccountNameInquiry,
+  accountNameInquirySchema,
+} from './accountNameInquiry.js';
+import { Aci, aciSchema } from './aci.js';
+import {
+  AuthorizationCurrency,
+  authorizationCurrencySchema,
+} from './authorizationCurrency.js';
+import {
+  AuthorizationSource,
+  authorizationSourceSchema,
+} from './authorizationSource.js';
+import { AvsResponseCode, avsResponseCodeSchema } from './avsResponseCode.js';
+import { CardholderId, cardholderIdSchema } from './cardholderId.js';
+import {
+  CodeAndDescription,
+  codeAndDescriptionSchema,
+} from './codeAndDescription.js';
+import { EntryMode, entryModeSchema } from './entryMode.js';
+import {
+  MailPhoneIndicator,
+  mailPhoneIndicatorSchema,
+} from './mailPhoneIndicator.js';
+import { NetworkGroup, networkGroupSchema } from './networkGroup.js';
+import { OriginType, originTypeSchema } from './originType.js';
+import { PinLess, pinLessSchema } from './pinLess.js';
+import {
+  PosConditionCode,
+  posConditionCodeSchema,
+} from './posConditionCode.js';
+import {
+  TerminalCapability,
+  terminalCapabilitySchema,
+} from './terminalCapability.js';
+import {
+  TransactionStatus,
+  transactionStatusSchema,
+} from './transactionStatus.js';
+import { TransactionType, transactionTypeSchema } from './transactionType.js';
+
+export interface TransactionDetails2 {
+  /** The unique 12-19 digit identifier that is generated with every card transaction and from the electronic transfer of funds. */
+  transactionId?: string;
+  /** Refers to the date when the transaction has been processed for settlement between the two parties. */
+  processDate?: string;
+  /** Refers to the date and time when the bank has settled the transaction (deposits or withdraws funds). */
+  transactionDateTime?: string;
+  /** The approved amount of money to be charged. */
+  authorizationAmount?: number;
+  /** The agreed upon sum for a transaction after authorization and processing steps. */
+  approvedAmount?: number;
+  /** The six number code from the issuing bank to the vendor that authorizes the sale. */
+  authorizationCode?: string;
+  authorizationCurrency?: AuthorizationCurrency;
+  authorizationSource?: AuthorizationSource;
+  transactionType?: TransactionType;
+  transactionStatus?: TransactionStatus;
+  entryMode?: EntryMode;
+  avsResponseCode?: AvsResponseCode;
+  cardholderId?: CardholderId;
+  /** Te unique order identifier indicating the transaction or event sequence. */
+  sequenceNumber?: string;
+  /** The ecommerce authorization identifier. */
+  authorizationIdentifier?: string;
+  /** The unique identifier of the purchaser associated with the transaction. */
+  customerIdentifier?: string;
+  /** The merchant-designated identifier for this transaction. */
+  merchantOrderIdentifier?: string;
+  /** The merchant-specified identifier used to track transactions associated with specific marketing campaigns. */
+  campaign?: string;
+  /** The merchant-specified identifier used to track transactions associated with your affiliate organizations. */
+  affiliate?: string;
+  /** The merchant-specified identifier for grouping transactions by an additional transaction level id outside of affiliate or campaign. */
+  merchantGroupingIdentifier?: string;
+  /** The reporting group category to which the transaction belongs. */
+  reportGroup?: string;
+  aci?: Aci;
+  mailPhoneIndicator?: MailPhoneIndicator;
+  originType?: OriginType;
+  /** The validation code for Visa card network transactions. */
+  validationCode?: string;
+  /** The unique identifier assigned to a point-of-sale terminal for tracking transactions and managing sales data. */
+  posRegisterNumber?: string;
+  /** The eight-digit sequence of characters used by financial institutions to monitor which terminal is used to process a transaction. */
+  terminalNumber?: string;
+  /** The key to uniquely identify a card transaction based on the ISO 8583 standard. */
+  referenceNumber?: string;
+  /** The merchant reference or draft locator number. */
+  draftLocator?: string;
+  terminalCapability?: TerminalCapability;
+  /** The date when funds or securities are delivered to complete the transaction. */
+  arrivalDate?: string;
+  /** The classification of the transaction processing method for financial reconciliation. */
+  settlementType?: string;
+  /** Process of converting debit card transactions to signature based transactions. Possible values are True or False. */
+  signatureDebitConversion?: boolean;
+  /** The unique 15-digit identification number for the terminal. */
+  terminalId?: string;
+  /** The location identifier or address for the physical point-of-sale device or processing equipment. */
+  terminalAddress?: string;
+  /** The city where the physical point-of-sale device or processing equipment is located. */
+  terminalCity?: string;
+  /** The state where the physical point-of-sale device or processing equipment is located. */
+  terminalState?: string;
+  /** Mechanism to resolve disputes or conflicts in settlements. */
+  tieBreaker?: string;
+  /** The amount of the previous transaction a merchant submitted to the customer's issuing bank for approval. */
+  oldAuthorizationAmount?: number;
+  /** The 11-byte unique identifier assigned to a group of transactions that were handled together as a single unit. */
+  batchNumber?: number;
+  /** The amount refunded to the cardholder's account that is a small percentage of the sum spent on purchases. */
+  cashbackAmount?: number;
+  /** The additional amount given in appreciation for a service. */
+  gratuityAmount?: number;
+  /** Indicates network id */
+  networkId?: string;
+  networkGroup?: NetworkGroup;
+  /** The initial justification for reauthorizing a transaction. */
+  originalReAuthorizationReason?: string;
+  /** The unique reference number associated with a voucher. */
+  voucherNumber?: string;
+  posConditionCode?: PosConditionCode;
+  /** The unique identifier and the brief description. */
+  toAccountType?: CodeAndDescription;
+  /** The unique identifier and the brief description. */
+  fromAccountType?: CodeAndDescription;
+  /** The amount still owed after a payment. */
+  remainingBalance?: number;
+  /** If a financial transaction is completed and settled. */
+  settled?: boolean;
+  pinLess?: PinLess;
+  accountNameInquiry?: AccountNameInquiry;
+  /** The unique identifier associated with a specific transaction that helps in tracking and reconciling payments across different systems. */
+  mastercardTransactionLinkId?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const transactionDetails2Schema: Schema<TransactionDetails2> = lazy(() =>
+  typedExpandoObject(
+    {
+      transactionId: ['transactionId', optional(string())],
+      processDate: ['processDate', optional(string())],
+      transactionDateTime: ['transactionDateTime', optional(string())],
+      authorizationAmount: ['authorizationAmount', optional(number())],
+      approvedAmount: ['approvedAmount', optional(number())],
+      authorizationCode: ['authorizationCode', optional(string())],
+      authorizationCurrency: [
+        'authorizationCurrency',
+        optional(authorizationCurrencySchema),
+      ],
+      authorizationSource: [
+        'authorizationSource',
+        optional(authorizationSourceSchema),
+      ],
+      transactionType: ['transactionType', optional(transactionTypeSchema)],
+      transactionStatus: [
+        'transactionStatus',
+        optional(transactionStatusSchema),
+      ],
+      entryMode: ['entryMode', optional(entryModeSchema)],
+      avsResponseCode: ['avsResponseCode', optional(avsResponseCodeSchema)],
+      cardholderId: ['cardholderId', optional(cardholderIdSchema)],
+      sequenceNumber: ['sequenceNumber', optional(string())],
+      authorizationIdentifier: ['authorizationIdentifier', optional(string())],
+      customerIdentifier: ['customerIdentifier', optional(string())],
+      merchantOrderIdentifier: ['merchantOrderIdentifier', optional(string())],
+      campaign: ['campaign', optional(string())],
+      affiliate: ['affiliate', optional(string())],
+      merchantGroupingIdentifier: [
+        'merchantGroupingIdentifier',
+        optional(string()),
+      ],
+      reportGroup: ['reportGroup', optional(string())],
+      aci: ['aci', optional(aciSchema)],
+      mailPhoneIndicator: [
+        'mailPhoneIndicator',
+        optional(mailPhoneIndicatorSchema),
+      ],
+      originType: ['originType', optional(originTypeSchema)],
+      validationCode: ['validationCode', optional(string())],
+      posRegisterNumber: ['posRegisterNumber', optional(string())],
+      terminalNumber: ['terminalNumber', optional(string())],
+      referenceNumber: ['referenceNumber', optional(string())],
+      draftLocator: ['draftLocator', optional(string())],
+      terminalCapability: [
+        'terminalCapability',
+        optional(terminalCapabilitySchema),
+      ],
+      arrivalDate: ['arrivalDate', optional(string())],
+      settlementType: ['settlementType', optional(string())],
+      signatureDebitConversion: [
+        'signatureDebitConversion',
+        optional(boolean()),
+      ],
+      terminalId: ['terminalId', optional(string())],
+      terminalAddress: ['terminalAddress', optional(string())],
+      terminalCity: ['terminalCity', optional(string())],
+      terminalState: ['terminalState', optional(string())],
+      tieBreaker: ['tieBreaker', optional(string())],
+      oldAuthorizationAmount: ['oldAuthorizationAmount', optional(number())],
+      batchNumber: ['batchNumber', optional(number())],
+      cashbackAmount: ['cashbackAmount', optional(number())],
+      gratuityAmount: ['gratuityAmount', optional(number())],
+      networkId: ['networkId', optional(string())],
+      networkGroup: ['networkGroup', optional(networkGroupSchema)],
+      originalReAuthorizationReason: [
+        'originalReAuthorizationReason',
+        optional(string()),
+      ],
+      voucherNumber: ['voucherNumber', optional(string())],
+      posConditionCode: ['posConditionCode', optional(posConditionCodeSchema)],
+      toAccountType: ['toAccountType', optional(codeAndDescriptionSchema)],
+      fromAccountType: ['fromAccountType', optional(codeAndDescriptionSchema)],
+      remainingBalance: ['remainingBalance', optional(number())],
+      settled: ['settled', optional(boolean())],
+      pinLess: ['pinLess', optional(pinLessSchema)],
+      accountNameInquiry: [
+        'accountNameInquiry',
+        optional(accountNameInquirySchema),
+      ],
+      mastercardTransactionLinkId: [
+        'mastercardTransactionLinkID',
+        optional(string()),
+      ],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/transactionStatus.ts

@@ -0,0 +1,33 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface TransactionStatus {
+  /** The identifier code. */
+  code?: string;
+  /** The short description of the code. */
+  shortDescription?: string;
+  /** The long description of the code. */
+  longDescription?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const transactionStatusSchema: Schema<TransactionStatus> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/transactionStatusCode.ts

@@ -0,0 +1,34 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** The statuses for the type of transactions. */
+export interface TransactionStatusCode {
+  /** The code of the transaction status. */
+  code?: string;
+  /** The short description of the transaction status. */
+  shortDescription?: string;
+  /** The long description of the transaction status. */
+  longDescription?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const transactionStatusCodeSchema: Schema<TransactionStatusCode> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);