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.

Prerequisites

• Device: PAX Technology Android device (FRv6 terminal)
• Android: Minimum Android API level 24 (Android 7.0)
• PAX App: The PAX payment application must be installed on the device

Install

yarn add capacitor-pax-payment
yarn cap sync

Example Plugin Usage

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

const initiatePayment = async () => {
  try {
    const result = await PaxPayment.initiateTransaction({
      amount: '100', // 1.00 € in smallest currency unit
      currency: '978', // ISO 4217 currency code for Euro
      beneficiary: 'John Doe',
      transactionType: 'DEBIT',
    });

    if (result.status === 'success') {
      console.log('Transaction successful:', result.transactionNumber);
      console.log('Message:', result.successMessage);
    } else {
      console.error('Transaction failed:', result.errorCode, result.errorMessage);
    }
  } catch (error) {
    console.error('Failed to initiate payment:', error);
  }
};

PAX Error Codes

The plugin returns specific error codes from the PAX payment system. Here's a reference:

| Code | Description | |------|-------------| | 00 | Transaction successful | | 01 | Transaction was refused | | 02 | Transaction was aborted | | 03 | An error occurred | | 04 | Invalid request | | 08 | Transaction type not authorized | | 09 | Original transaction not found | | ActivityResultNotOK | Transaction was canceled by the user or failed at the activity level |

Note: The error code 00 indicates success. All other codes indicate various failure scenarios.

API

• initiateTransaction(...)
• Interfaces
• Enums

initiateTransaction(...)

initiateTransaction(options: TransactionOptions) => any

Initiates a payment transaction with the PAX system.

| Param | Type | Description | | ------------- | ----------------------------------------------------------------- | ------------------------------------ | | options | TransactionOptions | Transaction options for the payment. |

Returns: any

Interfaces

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. | | beneficiary | string | The beneficiary name (optional). | | transactionType | TransactionType | The transaction type (optional). |

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. |

Enums

TransactionType

| Members | Value | Description | | ----------- | -------------------- | ---------------------------------------------------------- | | DEBIT | 'DEBIT' | A debit transaction. This is the default transaction type. |