Capacitor-pax-payment NPM

Capacitor Pax Payment

A plugin for initiating and managing payments via PAX FRv6 terminals, handling transactions and broadcasting results for seamless app-to-app integration.

Note: This plugin is designed to work exclusively with PAX FRv6 terminals. It will not function with other terminal models.

Install

yarn add capacitor-pax-payment
yarn cap sync

Example Plugin Usage

import { PaxPayment } from 'capacitor-pax-payment';

const initiatePayment = async () => {
  try {
    await PaxPayment.initiateTransaction({
      amount: '100',
      currency: '978',
      transactionType: 'DEBIT',
    });
  } catch (error) {
    console.error('Failed to initiate payment:', error);
  }
};

initiateTransaction(...)

initiateTransaction(options: TransactionOptions) => Promise<TransactionResult>

Initiates a payment transaction with the PAX system.

Param	Type	Description
`options`	TransactionOptions	Transaction options for the payment.

Returns: Promise<TransactionResult>

Interfaces

TransactionResult

Represents the result of a transaction.

Prop	Type	Description
`status`	'success' \| 'failure'	The status of the transaction. - 'success' indicates the transaction was successful. - 'failure' indicates the transaction failed.
`successMessage`	string	A message describing the success of the transaction. Present only if the transaction succeeds.
`transactionNumber`	string	The transaction number for identifying the transaction. Optional, only present if the transaction succeeds.
`errorCode`	string	The error code returned in case of failure. Optional, only present if the transaction fails.
`errorMessage`	string	A detailed error message, if available. Optional, only present if the transaction fails.

TransactionOptions

Represents the options for a transaction.

Prop	Type	Description
`amount`	string	The amount for the transaction, in the smallest currency unit (e.g., 1.25 € = "125"). Must be a string containing only positive digits
`currency`	string	The ISO 4217 currency code (e.g., "978" for Euro, "840" for US Dollar...). This should be a 3-digit currency code.
`transactionType`	TransactionType	The transaction type (optional).