@connexup/react-native-square-mobile-payment-sdk 0.1.0

package/src/payment/NativeMobilePaymentPayment.ts

@@ -0,0 +1,1220 @@
+import {
+  type CodegenTypes,
+  type TurboModule,
+  TurboModuleRegistry,
+} from 'react-native';
+
+export interface Spec extends TurboModule {
+  startPayment(
+    paymentParameters: PaymentParameters,
+    promptParameters: PromptParameters
+  ): Promise<void>;
+
+  availableCardInputMethods(): CardInputMethod[];
+
+  additionalPaymentMethods(): AdditionalPaymentMethod[];
+
+  triggerPaymentWithAdditionalPaymentMethod(
+    paymentSource: PaymentSource
+  ): Promise<void>;
+
+  //only ios
+  currentPayment(): Payment | null;
+
+  //only ios
+  isCurrentPaymentCancelable(): boolean;
+
+  cancelCurrentPayment(): Promise<boolean>;
+
+  readonly onAvailableCardInputMethodsChange: CodegenTypes.EventEmitter<
+    CardInputMethod[]
+  >;
+
+  readonly onPaymentFlowStatusChange: CodegenTypes.EventEmitter<PaymentFlowStatusChangedEvent>;
+}
+
+export const NativeMobilePaymentPayment =
+  TurboModuleRegistry.getEnforcing<Spec>('NativeMobilePaymentPayment');
+
+export type MobilePaymentPayment = {
+  startPayment(
+    paymentParameters: PaymentParameters,
+    promptParameters: PromptParameters,
+    listener?: PaymentFlowListener
+  ): Promise<PaymentHandle>;
+
+  availableCardInputMethods(): ReturnType<Spec['availableCardInputMethods']>;
+};
+
+export interface PaymentFlowListener {
+  /**
+   * only iOS
+   * This method is called when payment has been started and the an idempotency key has
+   *  been generated, but no further action has been taken.
+   */
+  didStart?: (payment: Payment | null) => void;
+
+  /**
+   * This method is called when payment has succeeded and the payment flow has been dismissed.
+   * You can now start a new payment.
+   */
+  didFinish?: (payment: Payment) => void;
+
+  /**
+   * This method is called when a payment error occurs.
+   */
+  didFail?: (payment: Payment | null, error: any) => void;
+
+  /**
+   * This method is called when payment has succeeded and the payment flow is about to be dismissed.
+   * Use this method to prepare your UI before the payment flow is dismissed.
+   */
+  didCancel?: (payment: Payment | null) => void;
+
+  /**
+   * only iOS
+   * This method is called when payment has succeeded and the payment flow is about to be dismissed.
+   * Use this method to prepare your UI before the payment flow is dismissed.
+   */
+  willFinish?: (payment: Payment | null) => void;
+
+  /**
+   * only iOS
+   * This method is called when payment cancellation is about to be completed. If the payment flow
+   * has been presented, use this method to prepare your UI before the payment flow is dismissed.
+   */
+  willCancel?: (payment: Payment | null) => void;
+}
+
+export type PaymentHandle = {
+  additionalPaymentMethods(): ReturnType<Spec['additionalPaymentMethods']>;
+
+  triggerPaymentWithPaymentSource(
+    parameters: PaymentSource
+  ): ReturnType<Spec['triggerPaymentWithAdditionalPaymentMethod']>;
+
+  payment(): ReturnType<Spec['currentPayment']>;
+
+  isPaymentCancelable(): ReturnType<Spec['isCurrentPaymentCancelable']>;
+
+  cancelPayment(): ReturnType<Spec['cancelCurrentPayment']>;
+};
+
+export type CardInputMethod = 'SWIPE' | 'CHIP' | 'CONTACTLESS';
+
+export interface Theme {
+  /**
+   * The color of the title label. (#RRGGBB or #RRGGBBAA)
+   */
+  titleColor?: string;
+  /**
+   * The font of the title label.
+   */
+  titleFont?: Font;
+  /**
+   * The color of the subtitle label. (#RRGGBB or #RRGGBBAA)
+   */
+  subtitleColor?: string;
+
+  /**
+   * The font of the subtitle label.
+   */
+  subtitleFont?: Font;
+
+  /**
+   * The tint color currently reflected in:
+   * - The primary action buttons background color
+   * (#RRGGBB or #RRGGBBAA)
+   */
+  tintColor?: string;
+
+  /**
+   * Background color of the payment flow that is displayed.
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  backgroundColor?: string;
+
+  /**
+   * Text color of the primary action button
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  buttonTextColor?: string;
+
+  /**
+   * Font of the primary action button
+   */
+  buttonFont?: Font;
+
+  /**
+   * Corner radius of the primary action button.
+   */
+  buttonCornerRadius?: number;
+
+  /**
+   * Tint color used on informative icons
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  informationIconColor?: string;
+
+  /**
+   * Tint color used on success icons
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  successIconColor?: string;
+
+  /**
+   * Tint color used on error icons
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  errorIconColor?: string;
+
+  /**
+   * Corner radius of the prompt that is displayed.
+   */
+  cornerRadius?: number;
+
+  /**
+   * Presentation style of the payment flow.
+   */
+  presentationStyle?: PresentationStyle;
+
+  /**
+   * Background color used on input fields
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  inputFieldColor?: string;
+
+  /**
+   * Text color used on input fields
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  inputFieldTextColor?: string;
+
+  /**
+   * Color used for placeholdertext on input fields
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  inputFieldPlaceholderTextColor?: string;
+
+  /**
+   * Color used for errors shown for input fields
+   *  (#RRGGBB or #RRGGBBAA)
+   */
+  inputFieldErrorColor?: string;
+}
+
+/**
+ * ios:UIFont
+ */
+//TODO more params
+export interface Font {
+  size?: number;
+  fontName?: FontName;
+}
+
+export type FontName = 'Inter-Regular' | 'Inter-Medium' | 'Inter-Bold';
+
+/**
+ * AUTOMATIC:
+ * Reader SDK will choose an appropriate presentation style based on the current environment.
+ * For example, on iPad the payment flow may be displayed as an overlay instead of fullscreen.
+ *
+ * ALWAYS_FULLSCREEN:
+ * Shows the payment flow over the entire window of the screen.
+ */
+export type PresentationStyle = 'AUTOMATIC' | 'ALWAYS_FULLSCREEN';
+
+export interface PaymentParameters {
+  /**
+   * allowCardSurcharge: Boolean is now a required parameter
+   *
+   * Set to false to maintain existing behavior (no surcharge)
+   * Set to true to enable card surcharge functionality (requires Beta opt-in and Dashboard configuration)
+   */
+  allowCardSurcharge: boolean;
+
+  /**
+   * A unique identifier for the payment attempt. When provided, Mobile Payments SDK generates a unique idempotency key for the payment request and stores it with the payment attempt ID.
+   */
+  paymentAttemptId: string;
+
+  /**
+   * If set to true and charging a Square Gift Card,
+   * a payment may be returned with amountMoney equal to less than what was requested.
+   * Example, a request for $20 when charging a Square Gift Card with balance of $5 will result in an APPROVED payment of $5.
+   * You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment.
+   * Cannot be true when autocomplete = true.
+   * If this parameter is passed as true but the buyer selected a payment method for which partial authorization does not apply eg: cash then this parameter is ignored.
+   * For more information, see Partial amount with Square gift cards. Defaults to false
+   */
+  acceptPartialAuthorization?: boolean;
+
+  /**
+   * If set to true, this payment will be completed when possible.
+   * If set to false, this payment will be held in an approved state until either explicitly completed (captured) or canceled (voided).
+   * For more information, see (https://developer.squareup.com/docs/payments-api/take-payments#delayed-payments)
+   */
+  autocomplete?: boolean;
+
+  /**
+   * Actions possible when an authorized payment is neither canceled nor completed in time.
+   */
+  delayAction?: DelayAction;
+
+  /**
+   * iOS:
+   * The action to apply to the payment when the <code>delayDuration</code> has elapsed. Defaults to <code>cancel</code>.
+   * note:
+   * Setting this to <code>complete</code> while the <code>orderID</code> parameter is set will fail validation.
+   * To learn more about this behavior, see the <a href="https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold">Delayed Capture: Time threshold</a> section.
+   * NSTimeInterval delayDuration
+   *
+   * android:
+   * Sets the duration between payment creation and automatic cancellation, for payments with autocomplete equal to false.
+   */
+  delayDuration?: number;
+
+  /**
+   * The amount of money to accept for this payment, not including [tipMoney]
+   */
+  amountMoney: Money;
+
+  /**
+   * The amount designated as a tip, in addition to [amountMoney]
+   */
+  tipMoney?: Money;
+
+  /**
+   * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller.
+   * Cannot be more than 90% of the total amount of the Payment.
+   */
+  appFeeMoney?: Money;
+
+  /**
+   * The location ID to associate with the payment. If not specified, the default location is used.
+   */
+  locationID?: string;
+
+  /**
+   * Associate a previously created order with this payment.
+   */
+  orderID?: string;
+
+  /**
+   * A user-defined ID to associate with the payment.
+   * You can use this field to associate the payment to an entity in an external system.
+   * For example, you might specify an order ID that is generated by a third-party shopping cart
+   */
+  referenceID?: string;
+
+  /**
+   * The ID of the customer associated with the payment.
+   * This value is required when using a customer’s card on file to create a payment.
+   */
+  customerID?: string;
+
+  /**
+   *  EMPLOYEES_READ permission.
+   * An optional ID of the team member associated with taking the payment.
+   */
+  teamMemberID?: string;
+
+  /**
+   * An optional note to be entered by the developer when creating a payment.
+   */
+  note?: string;
+
+  /**
+   * Optional additional payment information to include on the customer’s card statement as part of statement description.
+   */
+  statementDescriptionIdentifier?: string;
+
+  /**
+   * only iOS
+   * Optional card handle that references a stored swiped card.
+   * When a valid swiped card is set, the stored card will be used as the payment method, and payment selection will be skipped.
+   */
+  // TODO  at iOS add ReadCardInfoObserver and store cardHandle
+  // cardHandle
+
+  /**
+   * PaymentParameters "processingMode" parameter will determine whether the current payment needs to be processed online or offline.
+   */
+  processingMode: ProcessingMode;
+}
+
+export interface PromptParameters {
+  mode: PromptMode;
+  //TODO improve this
+  additionalMethods?: 'ALL' | 'KEYED';
+}
+
+export type PromptMode = 'DEFAULT' | 'CUSTOM';
+
+// A representation of a payment.
+// See (https://developer.squareup.com/reference/square/payments-api/create-payment) for more information.
+export interface Payment {
+  /**
+   * iOS:
+   * The server-side ID for this payment.
+   *
+   * android:
+   * Offline: Unique ID for this payment, assigned by Square.
+   * Value stays null until payment is uploaded and gets a server-side ID.
+   * Online:
+   * Unique ID for this payment, assigned by Square.
+   */
+  id?: string | null;
+
+  /**
+   * date of when the payment was created.(iso8601)
+   */
+  createdAt: string;
+
+  /**
+   * date of when the payment was created.(iso8601)
+   */
+  updatedAt: string;
+
+  /**
+   * Indicates the current payment status.
+   */
+  status?: PaymentStatus;
+
+  /**
+   * The amount of money to accept for this payment, not including [tipMoney]
+   */
+  amountMoney: Money;
+
+  /**
+   * The amount designated as a tip, in addition to [amountMoney]
+   */
+  tipMoney?: Money;
+
+  /**
+   * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller.
+   */
+  appFeeMoney?: Money;
+
+  /**
+   * The total money for the payment, including amountMoney and tipMoney.
+   */
+  totalMoney?: Money;
+
+  /**
+   * The location ID to associate with the payment. If not specified, the default location is used.
+   */
+  locationID?: string;
+
+  /**
+   * Associate a previously created order with this payment.
+   */
+  orderID?: string;
+
+  /**
+   * A user-defined ID to associate with the payment.
+   * You can use this field to associate the payment to an entity in an external system.
+   * For example, you might specify an order ID that is generated by a third-party shopping cart
+   */
+  referenceID?: string;
+
+  /**
+   * The ID of the customer associated with the payment.
+   * Required if the sourceID refers to a card on file created using the Customers API.
+   *
+   * android only Online
+   */
+  customerID?: string;
+
+  /**
+   * An optional note to be entered by the developer when creating a payment.
+   *
+   * android only Online
+   */
+  note?: string;
+
+  /**
+   * only android Online
+   */
+  statementDescription?: string;
+
+  /**
+   * only android Online
+   */
+  teamMemberId?: string;
+
+  /**
+   * Non-confidential details about the source.
+   */
+  cardDetails?: CardDetails;
+
+  /**
+   * only android
+   */
+  cashDetails?: CashPaymentDetails;
+
+  /**
+   * only android
+   */
+  externalDetails?: ExternalPaymentDetails;
+
+  processingType?: ProcessingType;
+
+  /**
+   * Timestamp of when the payment was uploaded for processing. (iso8601)
+   */
+  uploadedAt?: string | null;
+
+  /**
+   * processingType = OFFLINE
+   * Unique ID for this payment, generated when device is offline.
+   * Can be used to identify this Payment until it is uploaded to server
+   * and id becomes available.
+   */
+  localId?: string;
+
+  /**
+   * processingType = OFFLINE
+   * Indicates the [OfflineStatus] of the payment.
+   */
+  offlineStatus?: OfflineStatus;
+
+  /**
+   * only android
+   * processingType = ONLINE
+   * Processing fees and fee adjustments assessed by Square on this payment.
+   */
+  processingFee?: PaymentProcessingFee[];
+
+  sourceType?: PaymentSourceType;
+
+  /**
+   * only android
+   * processingType = ONLINE
+   */
+  capabilities?: PaymentCapabilities[];
+
+  /**
+   * only android
+   * processingType = ONLINE
+   */
+  receiptNumber?: string;
+
+  /**
+   * only android
+   * processingType = ONLINE
+   * Remaining balance on an account.
+   */
+  remainingBalance?: Money;
+
+  /**
+   * only android
+   * Details about a Square Account payment. The details are only populated
+   * if the [sourceType] is [SourceType.SQUARE_ACCOUNT].
+   */
+  squareAccountDetails?: SquareAccountDetails | null;
+
+  /**
+   * only android
+   */
+  digitalWalletDetails?: DigitalWalletDetails | null;
+}
+
+export interface Money {
+  /**
+   * The amount of money in the smallest denomination of the currency.
+   * For example, when currency is .usd, the amount is in cents.
+   */
+  amount: number;
+  /**
+   * The currency code.
+   */
+  currency: Currency;
+}
+
+export type Currency =
+  | 'AUD'
+  | 'CAD'
+  | 'EUR'
+  | 'GBP'
+  | 'JPY'
+  | 'USD'
+  | 'AED'
+  | 'AFN'
+  | 'ALL'
+  | 'AMD'
+  | 'ANG'
+  | 'AOA'
+  | 'ARS'
+  | 'AWG'
+  | 'AZN'
+  | 'BAM'
+  | 'BBD'
+  | 'BDT'
+  | 'BGN'
+  | 'BHD'
+  | 'BIF'
+  | 'BMD'
+  | 'BND'
+  | 'BOB'
+  | 'BOV'
+  | 'BRL'
+  | 'BSD'
+  | 'BTN'
+  | 'BWP'
+  | 'BYR'
+  | 'BZD'
+  | 'CDF'
+  | 'CHE'
+  | 'CHF'
+  | 'CHW'
+  | 'CLF'
+  | 'CLP'
+  | 'CNY'
+  | 'COP'
+  | 'COU'
+  | 'CRC'
+  | 'CUC'
+  | 'CUP'
+  | 'CVE'
+  | 'CZK'
+  | 'DJF'
+  | 'DKK'
+  | 'DOP'
+  | 'DZD'
+  | 'EGP'
+  | 'ERN'
+  | 'ETB'
+  | 'FJD'
+  | 'FKP'
+  | 'GEL'
+  | 'GHS'
+  | 'GIP'
+  | 'GMD'
+  | 'GNF'
+  | 'GTQ'
+  | 'GYD'
+  | 'HKD'
+  | 'HNL'
+  | 'HRK'
+  | 'HTG'
+  | 'HUF'
+  | 'IDR'
+  | 'ILS'
+  | 'INR'
+  | 'IQD'
+  | 'IRR'
+  | 'ISK'
+  | 'JMD'
+  | 'JOD'
+  | 'KES'
+  | 'KGS'
+  | 'KHR'
+  | 'KMF'
+  | 'KPW'
+  | 'KRW'
+  | 'KWD'
+  | 'KYD'
+  | 'KZT'
+  | 'LAK'
+  | 'LBP'
+  | 'LKR'
+  | 'LRD'
+  | 'LSL'
+  | 'LTL'
+  | 'LVL'
+  | 'LYD'
+  | 'MAD'
+  | 'MDL'
+  | 'MGA'
+  | 'MKD'
+  | 'MMK'
+  | 'MNT'
+  | 'MOP'
+  | 'MRO'
+  | 'MUR'
+  | 'MVR'
+  | 'MWK'
+  | 'MXN'
+  | 'MXV'
+  | 'MYR'
+  | 'MZN'
+  | 'NAD'
+  | 'NGN'
+  | 'NIO'
+  | 'NOK'
+  | 'NPR'
+  | 'NZD'
+  | 'OMR'
+  | 'PAB'
+  | 'PEN'
+  | 'PGK'
+  | 'PHP'
+  | 'PKR'
+  | 'PLN'
+  | 'PYG'
+  | 'QAR'
+  | 'RON'
+  | 'RSD'
+  | 'RUB'
+  | 'RWF'
+  | 'SAR'
+  | 'SBD'
+  | 'SCR'
+  | 'SDG'
+  | 'SEK'
+  | 'SGD'
+  | 'SHP'
+  | 'SLL'
+  | 'SOS'
+  | 'SRD'
+  | 'SSP'
+  | 'STD'
+  | 'SVC'
+  | 'SYP'
+  | 'SZL'
+  | 'THB'
+  | 'TJS'
+  | 'TMT'
+  | 'TND'
+  | 'TOP'
+  | 'TRY'
+  | 'TTD'
+  | 'TWD'
+  | 'TZS'
+  | 'UAH'
+  | 'UGX'
+  | 'USN'
+  | 'USS'
+  | 'UYI'
+  | 'UYU'
+  | 'UZS'
+  | 'VEF'
+  | 'VND'
+  | 'VUV'
+  | 'WST'
+  | 'XAF'
+  | 'XAG'
+  | 'XAU'
+  | 'XBA'
+  | 'XBB'
+  | 'XBC'
+  | 'XBD'
+  | 'XCD'
+  | 'XDR'
+  | 'XOF'
+  | 'XPD'
+  | 'XPF'
+  | 'XPT'
+  | 'XTS'
+  | 'XXX'
+  | 'YER'
+  | 'ZAR'
+  | 'ZMK'
+  | 'ZMW'
+  | 'BTC'
+  | 'XUS'
+  | 'SLE'
+  | 'UNKNOWN';
+
+export interface AdditionalPaymentMethod {
+  /**
+   * The type of the payment that is being presented
+   */
+  type: AdditionalPaymentMethodType;
+  /**
+   * Localized string value of the payment type that is consumer friendly
+   */
+  name: string;
+}
+
+export type DelayAction =
+  | 'CANCEL' //The authorized payment is canceled and payment is not taken from the buyer.
+  | 'COMPLETE'; //The authorized payment is completed, taking payment from the buyer.
+
+export type ProcessingMode =
+  | 'ONLINE_ONLY' //In ONLINE_ONLY mode, the payment can only be processed via network call. The payment is ONLINE_ONLY by default.
+  | 'OFFLINE_ONLY' //In OFFLINE_ONLY mode, the payment will be stored in the database, even if connectivity is OK.
+  | 'AUTO_DETECT'; //n AUTO_DETECT mode, we will verify the status of the network and Square systems health before processing the payment and determine whether it needs to be processed online or offline.
+
+export type ProcessingType = 'ONLINE' | 'OFFLINE';
+
+export type OfflineStatus =
+  | 'UNKNOWN'
+  | 'QUEUED' //Payment is on your device only but Reader SDK will attempt to upload it soon.
+  | 'UPLOADED' //Payment has been uploaded to the Square Server. Your money is safe now!
+  | 'FAILED_TO_UPLOAD' //Payment could not be uploaded, due to the unrecoverable error.
+  | 'FAILED_TO_PROCESS' //Square Server couldn't process your offline payment, maybe the card was declined or something.
+  | 'PROCESSED'; //Square Server processed your offline payment successfully, you can now see it in your merchant dashboard.
+
+export interface BasePaymentSource {
+  type: AdditionalPaymentMethodType;
+}
+
+export interface CardOnFilePaymentSource extends BasePaymentSource {
+  type: 'CARD_ON_FILE';
+  cardID: string;
+  customerID: string; //android required
+}
+
+export interface HouseAccountPaymentSourceAndroid extends BasePaymentSource {
+  type: 'HOUSE_ACCOUNT';
+  paymentSourceToken: string;
+  customerId: string;
+}
+
+export interface HouseAccountPaymentSourceIOS extends BasePaymentSource {
+  type: 'HOUSE_ACCOUNT';
+  houseAccountPaymentSourceId: string;
+}
+
+export type HouseAccountPaymentSource =
+  | HouseAccountPaymentSourceAndroid
+  | HouseAccountPaymentSourceIOS;
+
+//only ios
+export interface CashPaymentSource extends BasePaymentSource {
+  type: 'CASH';
+  //only android
+  buyerSuppliedMoney?: Money;
+}
+
+//only android
+// export interface ExternalPaymentSource extends BasePaymentSource {
+//     type: "EXTERNAL";
+//     externalTenderTyp: ExternalTenderType;
+//     source: string;
+//     sourceId?: string | null;
+//     sourceFeeMoney?: Money | null;
+// }
+
+export type SimplePaymentSource = {
+  type: Exclude<
+    AdditionalPaymentMethodType,
+    'CARD_ON_FILE' | 'HOUSE_ACCOUNT' | 'CASH' | 'EXTERNAL'
+  >;
+};
+
+export type ExternalTenderType =
+  | 'CHECK' // Paid using a physical check.
+  | 'BANK_TRANSFER' // Paid using external bank transfer.
+  | 'OTHER_GIFT_CARD' // Paid using a non-Square gift card.
+  | 'CRYPTO' // Paid using a crypto currency.
+  | 'SQUARE_CASH' // Paid using Square Cash App.
+  | 'SOCIAL' // Paid using peer-to-peer payment applications.
+  | 'EXTERNAL' // A third-party application gathered this payment outside of Square.
+  | 'EMONEY' // Paid using an E-money provider.
+  | 'CARD' // A credit or debit card that Square does not support.
+  | 'STORED_BALANCE' // Use for house accounts, store credit, and so forth.
+  | 'FOOD_VOUCHER' // Restaurant voucher provided by employers to employees to pay for meals.
+  | 'OTHER'; // A type not listed here.
+
+export type PaymentSource =
+  | CardOnFilePaymentSource
+  | HouseAccountPaymentSource
+  | CashPaymentSource
+  // | ExternalPaymentSource
+  | SimplePaymentSource;
+
+export type AdditionalPaymentMethodType =
+  | 'KEYED'
+  | 'CARD_ON_FILE' // only ios
+  | 'HOUSE_ACCOUNT' //only ios
+  | 'TAP_TO_PAY' //only ios
+  | 'CASH' //only ios
+  // | "EXTERNAL" //only android
+  // | "CASH_APP_QR" //only android
+  // | "PAY_PAY_QR" //only android
+  | 'UNKNOWN';
+
+export type PaymentStatus =
+  | 'UNKNOWN'
+  | 'PENDING' //only ios
+  | 'INITIALIZED'
+  | 'APPROVED'
+  | 'COMPLETED'
+  | 'CANCELED'
+  | 'FAILED';
+
+export type PaymentSourceType =
+  | 'CARD'
+  | 'CASH'
+  | 'EXTERNAL'
+  | 'WALLET'
+  | 'BANK_ACCOUNT'
+  | 'CARD_ON_FILE'
+  | 'SQUARE_ACCOUNT'
+  | 'UNKNOWN';
+
+export type PaymentCapabilities =
+  | 'EDIT_TIP_AMOUNT_UP'
+  | 'EDIT_TIP_AMOUNT_DOWN'
+  | 'EDIT_AMOUNT_UP'
+  | 'EDIT_AMOUNT_DOWN';
+
+export interface PaymentProcessingFee {
+  /**
+   * date of the effectiveness.
+   */
+  effectiveAt: string;
+  /**
+   * type of the fee defined by Type
+   */
+  type: PaymentProcessingFeeType;
+  /**
+   * amount of the fee in for of Money
+   */
+  amountMoney: Money;
+}
+
+export type PaymentProcessingFeeType = 'INITIAL' | 'ADJUSTMENT';
+
+export interface CashPaymentDetails {
+  /**
+   *  The amount and currency of the money supplied by the buyer.
+   */
+  buyerSuppliedMoney: Money;
+  /**
+   *  The amount of change due back from the buyer.
+   */
+  changeBackMoney: Money;
+}
+
+export interface ExternalPaymentDetails {
+  /**
+   * The type of external payment the seller received. See ExternalTenderType.
+   */
+  type: string;
+  /**
+   * A description of the external payment source. For example, "Food Delivery Service"
+   */
+  source: string;
+
+  /**
+   * An ID provided by the developer to associate the payment to its originating source.
+   */
+  sourceId?: string | null;
+
+  /**
+   * The fees paid to the source. The amountMoney minus this field is the net amount seller receives.
+   */
+  sourceFeeMoney?: Money | null;
+}
+
+export interface CardDetails {
+  /**
+   * The status of the card payment.
+   */
+  status?: CardStatus;
+  /** Provides information about the card used for payment. */
+  card?: Card;
+  /** Indicate how the card information was captured. */
+  entryMethod?: EntryMethod;
+  /**
+   * For EMV payments, identifies the EMV application used for the payment.
+   */
+  applicationIdentifier?: string;
+  /**
+   * For EMV payments, the human-readable name of the EMV application used for the payment.
+   */
+  applicationName?: string;
+
+  /**
+   * only android
+   * EMV application transaction counter maintained by the application in the ICC.
+   */
+  applicationCounter?: string;
+
+  /**
+   * only android
+   * EMV tag 5F34, returned by the issuer to identify and differentiate cards with the same PAN.
+   */
+  panSequenceNumber?: string;
+
+  /**
+   * only android
+   * For EMV payments, the method used to verify the cardholder's identity.
+   */
+  verificationMethod?: EMVVerificationMethod;
+
+  /**
+   * only android
+   * For EMV payments, the results of the cardholder verification.
+   */
+  verificationResults?: EMVVerificationResult;
+
+  /**
+   * only android
+   * The type of account selected by the buyer using an EMV debit card.
+   */
+  accountType?: EMVAccountType;
+
+  /**
+   *  only android
+   *  The amount of money remaining on the card after this payment. Populated only for certain card types, when required for display on receipts.
+   */
+  remainingBalanceAmountMoney?: Money;
+
+  /**
+   * only android
+   * Felica SPRWID returned by TMN for Felica(e-money) TRANSPORTATION(Suica) transactions only.
+   */
+  felicaSprwdId?: Money;
+
+  /**
+   * Status code returned by the card issuer that describes the payment’s authorization status.
+   */
+  authResultCode?: string;
+
+  isOfflineCard?: boolean;
+}
+
+type CardStatus = 'UNKNOWN' | 'AUTHORIZED' | 'CAPTURED' | 'VOIDED' | 'FAILED';
+
+export type EntryMethod =
+  | 'SWIPED'
+  | 'KEYED'
+  | 'EMV'
+  | 'ON_FILE'
+  | 'CONTACTLESS'
+  | 'UNKNOWN';
+
+export interface Card {
+  /**
+   * Unique ID for this card. Generated by Square.
+   */
+  id?: string;
+  /**
+   * The card’s brand (such as VISA).
+   */
+  cardBrand: CardBrand;
+  /**
+   * The card’s CoBrand (such as Afterpay).
+   */
+  coBrand?: CardCoBrand;
+  /**
+   * The last 4 digits of the card number.
+   */
+  last4?: string;
+  /**
+   * The expiration month of the associated card as an integer between 1 and 12.
+   */
+  expMonth?: number;
+  /**
+   * The four-digit year of the card’s expiration date.
+   */
+  expYear?: number;
+  /**
+   * The name of the cardholder.
+   */
+  cardholderName?: string;
+
+  /**
+   * only android
+   * The first six digits of the card number.
+   */
+  bin?: string;
+}
+
+export type CardBrand =
+  | 'UNKNOWN'
+  | 'VISA'
+  | 'MASTERCARD'
+  | 'AMERICAN_EXPRESS'
+  | 'DISCOVER'
+  | 'DISCOVER_DINERS'
+  | 'JCB'
+  | 'CHINA_UNION_PAY'
+  | 'SQUARE_GIFT_CARD'
+  | 'SQUARE_CAPITAL_CARD'
+  | 'INTERAC'
+  | 'EFTPOS'
+  | 'FELICA'
+  | 'EBT'
+  | 'ALIPAY' // only android
+  | 'CASH_APP' // only android
+  | 'SUICA' // only android
+  | 'ID' // only android
+  | 'QUICPAY' // only android
+  | 'OTHER_BRAND';
+
+export type CardCoBrand =
+  | 'UNKNOWN'
+  | 'AFTERPAY'
+  | 'CLEARPAY' //only android
+  | 'NONE';
+
+export type EMVAccountType = 'SAVINGS' | 'CHECKING' | 'CREDIT';
+
+export type EMVVerificationMethod =
+  | 'PIN'
+  | 'SIGNATURE'
+  | 'PIN_AND_SIGNATURE'
+  | 'ON_DEVICE'
+  | 'NONE';
+
+export type EMVVerificationResult = 'SUCCESS' | 'FAILURE' | 'UNKNOWN';
+
+export interface SquareAccountDetails {
+  /**
+   * Unique identifier for the payment source used for this payment.
+   */
+  paymentSourceToken: string;
+  errors?: ErrorDetails[] | null;
+}
+
+export interface DigitalWalletDetails {
+  walletBrand?: WalletBrand | null;
+  buyerId?: string | null;
+}
+
+export type WalletBrand =
+  | 'CashApp'
+  | 'PayPay'
+  | 'Alipay'
+  | 'AuPay'
+  | 'DBarai'
+  | 'MerPay'
+  | 'RakutenPay'
+  | 'WechatPay'
+  | 'Unknown';
+
+/**
+ * Detailed errors to explain a failure.
+ * Typically these are returned from Square's Connect v2 REST APIs,
+ * and are documented here[https://developer.squareup.com/reference/square/objects/Error].
+ * However, there may be conditions where an error is generated by the SDK itself,
+ * for example to explain errors that prevented server or cardreader communication.
+ */
+export interface ErrorDetails {
+  /**
+   * The high-level category of the error.
+   */
+  category: string;
+  /**
+   * The specific code of the error.
+   */
+  code: string;
+  /**
+   * A human-readable description of the error for debugging purposes. This will be localized to the device locale.
+   */
+  detail: string;
+  /**
+   * The name of the field provided in the original request, if any, that the error pertains to.
+   */
+  field?: string | null;
+}
+
+export interface PaymentFlowStatusChangedEvent {
+  name:
+    | 'didStart'
+    | 'didFinish'
+    | 'didFail'
+    | 'didCancel'
+    | 'willFinish'
+    | 'willCancel';
+  payment?: Payment | null;
+  error?: {
+    message: string;
+  };
+}
+
+/**
+ * Reader SDK could not connect to the network.
+ */
+export const PaymentErrorNoNetwork = 'PAYMENT_ERROR_NO_NETWORK';
+
+/**
+ * Reader SDK is not currently authorized with a Square Seller account.
+ */
+export const PaymentErrorNotAuthorized = 'PAYMENT_ERROR_NOT_AUTHORIZED';
+/**
+ * Invalid payment parameters were provided.
+ */
+export const PaymentErrorInvalidPaymentParameters =
+  'PaymentErrorInvalidPaymentParameters';
+/**
+ * The payment timed out.
+ */
+export const PaymentErrorTimedOut = 'PAYMENT_ERROR_TIMED_OUT';
+/**
+ * Location permission is needed.
+ */
+export const PaymentErrorLocationPermissionNeeded =
+  'PAYMENT_ERROR_LOCATION_PERMISSION_NEEDED';
+/**
+ * Payment is already in progress.
+ */
+export const PaymentErrorPaymentAlreadyInProgress =
+  'PAYMENT_ERROR_PAYMENT_ALREADY_IN_PROGRESS';
+/**
+ * Idempotency key already in use.
+ */
+export const PaymentErrorIdempotencyKeyReused =
+  'PAYMENT_ERROR_IDEMPOTENCY_KEY_REUSED';
+/**
+ * Invalid Payment Source Provided
+ */
+export const PaymentErrorInvalidPaymentSource =
+  'PAYMENT_ERROR_INVALID_PAYMENT_SOURCE';
+
+/**
+ * Error that is thrown if a merchant is not opted into offline processing
+ */
+export const PaymentErrorMerchantNotOptedIntoOfflineProcessing =
+  'PAYMENT_ERROR_MERCHANT_NOT_OPTED_INTO_OFFLINE_PROCESSING';
+
+/**
+ * Error thrown when payment amount is too big and exceeds limit for offline processing
+ */
+export const PaymentErrorOfflineTransactionAmountExceeded =
+  'PAYMENT_ERROR_OFFLINE_TRANSACTION_AMOUNT_EXCEEDED';
+
+/**
+ * The total stored in the database if this payment is taken offline will exceed the total allowed in offline mode.
+ */
+export const PaymentErrorOfflineStoredAmountExceeded =
+  'PAYMENT_ERROR_OFFLINE_STORED_AMOUNT_EXCEEDED';
+
+/**
+ * Offline processing is unsupported in sandbox environment
+ */
+export const PaymentErrorSandboxUnsupportedForOfflineProcessing =
+  'PAYMENT_ERROR_SANDBOX_UNSUPPORTED_FOR_OFFLINE_PROCESSING';
+
+/**
+ * Unexpected Error Returned
+ */
+export const PaymentErrorUnexpected = 'PAYMENT_ERROR_UNEXPECTED';
+
+/**
+ * The device clock is skewed and not matching the server time.
+ */
+export const PaymentDeviceClockSkewed = 'PAYMENT_DEVICE_CLOCK_SKEWED';
+
+/**
+ * Unsupported mode for taking a payment; for example, multitasking mode is not allowed on iPad
+ */
+export const PaymentErrorUnsupportedMode = 'PAYMENT_ERROR_UNSUPPORTED_MODE';
+
+/**
+ * Merchant is in a market that requires consent for analytics and consent has not been provided
+ */
+export const PaymentConsentNotProvided = 'PAYMENT_CONSENT_NOT_PROVIDED';
+
+/**
+ * Consent is required for tracking purposes and the tracking consent selection is pending and waiting on user.
+ */
+export const PaymentTrackingConsentIsPending =
+  'PAYMENT_TRACKING_CONSENT_IS_PENDING';
+
+/**
+ * Your application provided idempotencyKey in a market where Square will create and manage idempotency keys. Please use paymentAttemptId instead.
+ */
+export const PaymentAttemptIdRequiredForSca =
+  'PAYMENT_ATTEMPT_ID_REQUIRED_FOR_SCA';
+
+/**
+ * The payment attempt id used for this payment has already been used. Review previous payments to ensure you are not processing a duplicate payment, and then try again with a new payment attempt id.
+ */
+export const PaymentAttemptIdReused = 'PAYMENT_ATTEMPT_ID_REUSED';