Library Reference

import * as eWallet from '@orchestrasolutions/ewallet';

const engine = new eWallet.Engine(
  sessionToken,           // Required: from POST /EWalletOperations
  requiredAncillaryInfo,  // Optional: address collection requirements
  language,               // Optional: UI language code
  uiOptions               // Optional: UI display options
);

const uiOptions = {
  hideLogo: true,                          // hide the logo on the card forms
  displayMode: 'iframe',                   // 'popup' (default) or 'iframe'
  iframeContainerSelector: '#card-form'    // CSS selector for inline iframe host
};

const engine = new eWallet.Engine(sessionToken, requiredAncillaryInfo, language, uiOptions);

const engine = new eWallet.Engine(sessionToken, undefined, 'de');

const available = await engine.checkAvailability();
// Returns: ["CardPay", "GooglePay", "PayPal", ...]

engine.payBy(
  eWalletList,           // Required: buttons to display
  callback,              // Required: called when payment completes
  buttonProperties,      // Optional: button styling
  requiredAncillaryInfo, // Optional: override address requirements
  iframeStyleConfig      // Optional: appearance of the CardPay forms
);

{ name: 'CardPay', domEntitySelector: '#card-button' }

const buttonProperties = {
  color: 'Dark',      // "Light" or "Dark"
  text: 'Pay',        // "None", "Pay", "Buy", "Subscribe", "Book", "Checkout", "Donate"
  width: '200px',
  height: '40px',
  logoPath: '/path/to/logo.png'  // Optional
};

engine.payBy(buttons, handleResult, buttonProperties);

const iframeStyleConfig = {
  colorPalette: { primary: '#6c2bd9', background: '#ffffff', text: '#1a1a2e', border: '#d0d0e0', error: '#d92b2b', success: '#1ea672' },
  field: {
    typography: { fontFamily: "'Roboto', sans-serif", fontSize: '15px', fontWeight: '500' },
    borderRadius: '6px',
    states: { focus: { borderColor: '#6c2bd9' }, invalid: { borderColor: '#d92b2b' } }
  },
  layout: { fieldLayout: 'stacked', labelPosition: 'top', fieldSpacing: '12px' },
  branding: { logoUrl: 'https://example.com/logo.svg', logoMaxHeight: '48px', showCardBrandIcon: true, showSecurityBadge: true },
  locale: 'en-GB',
  direction: 'ltr'
};

engine.payBy(buttons, handleResult, buttonProperties, undefined, iframeStyleConfig);

function handleResult(result) {
  if (!result) return;

  const [data, success] = engine.parseResultToken(result.token);

  if (!data.clientSuccess) {
    console.error('Payment failed:', data.clientErrorMessage);
    return;
  }

  // Check which type of result we received
  if (data.upgChargeResults) {
    // Payment processed through a PSP (CardPay, ApplePay, GooglePay)
    console.log('Gateway:', data.upgChargeResults.gatewayName);
    console.log('Reference:', data.upgChargeResults.gatewayReference);
    console.log('Amount:', data.upgChargeResults.amount, data.upgChargeResults.currency);
  }

  if (data.directChargeResults) {
    // Payment processed directly (PayPal, BankPay, UPI)
    console.log('Success:', data.directChargeResults.success);
    console.log('Message:', data.directChargeResults.message);
  }

  if (data.tokenAndMaskedCardModel) {
    // Tokenization result
    console.log('Token:', data.tokenAndMaskedCardModel.token);
    console.log('Card:', data.tokenAndMaskedCardModel.bankCard.type);
    console.log('Last 4:', data.tokenAndMaskedCardModel.bankCard.number);

    if (data.tokenAndMaskedCardModel.threeDS) {
      console.log('3DS ECI:', data.tokenAndMaskedCardModel.threeDS.eci);
    }
  }
}

const sessionType = engine.getSessionType();
// "CHARGE", "TOKENIZE", "CHARGE_AND_TOKENIZE", or "PREAUTH_AND_TOKENIZE"

function handleResult(result) {
  const provider = engine.getSelectedProviderName();
  console.log('Customer paid with:', provider);
  // "CardPay", "GooglePay", "ApplePay", "PayPal", "BankPay", or "UPI"
}

EWalletResultData {
  clientSuccess: boolean;
  clientErrorMessage: any;

  // For PSP charges (CardPay, ApplePay, GooglePay)
  upgChargeResults?: {
    gatewayName: string;
    gatewayReference: string;
    authorizationCode: string;
    amount: number;
    currency: string;
    operationType: string;  // "Charge", "PreAuth", etc.
    operationResultCode: string;  // "Success", "Rejected", etc.
    operationResultDescription: string;  // Human-readable result message
    gatewayResultDescription: string;  // Message from the payment gateway
  };

  // Earlier failed gateway attempts when a fallback chain ran.
  // upgChargeResults always holds the final attempt only (single object, never an array).
  // Absent when the first gateway attempt was the only one.
  failedUpgChargeResults?: Array<OperationResult>;  // same shape as upgChargeResults

  // Summary of the final result, present for every payment method
  selectedPaymentMethod: string;      // "CardPay", "ApplePay", "GooglePay", "PayPal", "BankPay" or "UPI"
  transactionAmount: number;          // standard currency unit
  transactionCurrency: string;        // ISO 4217
  transactionTimestamp: string;       // UTC, ISO 8601
  providerTransactionId: string;      // PSP reference of the final attempt
  providerAuthorizationCode: string;  // may be null
  providerAccountId: string;          // name of the gateway or eWallet account that processed it

  // One entry per processing attempt, primary first, fallbacks after. Abbreviated keys.
  attempts: Array<{
    seq: number;    // 1 for the first attempt
    prv: string;    // provider used, e.g. "CardPay"
    ts: string;     // UTC start time
    suc: boolean;   // attempt succeeded
    fail: string;   // failure reason, null on success
    err: string;    // provider error code, null on success
    dur: number;    // processing time in ms
    fb: boolean;    // this failure triggered a fallback
    req: string;    // sanitized request snapshot (JSON string), may be null
    res: string;    // sanitized response snapshot (JSON string), may be null
    tid: string;    // PSP transaction ID for this attempt
    auth: string;   // authorization code for this attempt
  }>;

  // For direct charges (PayPal, BankPay, UPI)
  directChargeResults?: {
    success: boolean;
    message: string;
    data: object;  // Provider-specific payload - structure varies by payment method. See note below.
  };

  // For tokenization
  tokenAndMaskedCardModel?: {
    token: string;
    bankCard: {
      type: string;      // "Visa", "MasterCard", etc.
      number: string;    // Masked: "************1234"
      expirationMonth: number;
      expirationYear: number;
      nameOnCard: string;
    };
    threeDS?: {
      eci: string;
      authenticationValue: string;
      xid: string;
      version: string;
    };
  };
}

const requiredAncillaryInfo = {
  billingInfo: {
    phoneRequired: true,
    emailAddressRequired: true,
    details: 'FULL'  // "MIN" or "FULL"
  },
  shippingInfo: {
    phoneRequired: false,
    emailAddressRequired: false
  }
};

const engine = new eWallet.Engine(sessionToken, requiredAncillaryInfo);

const requiredAncillaryInfo = {
  billingInfo: {
    fields: { name: true, countryCode: true, postalCode: true, phoneNumber: true }
  }
};

function handleResult(result) {
  if (!result) return;

  const billing = engine.getBillingInfo();
  if (billing) {
    console.log('Name:', billing.name);
    console.log('Email:', billing.emailAddress);
    console.log('Country:', billing.countryCode);
    console.log('Postal:', billing.postalCode);

    // FULL address fields (if requested)
    if (billing.addressLines) {
      console.log('Street:', billing.addressLines.join(', '));
      console.log('City:', billing.locality);
      console.log('State:', billing.administrativeArea);
    }
  }

  const shipping = engine.getShippingInfo();
  if (shipping) {
    console.log('Ship to:', shipping.name);
    console.log('Address:', shipping.addressLines?.join(', '));
  }
}