@aigens/aigens-sdk-anz-tap-mobile
v5.0.1
Published
Anz Tap Mobile
Readme
aigens-sdk-anz-tap-mobile
Anz Tap Mobile
ios
Configure URL scheme
Add the following key to your Info.plist file to configure the URL scheme for payment return:
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>YourAppPaymentReturn</string>
<key>CFBundleURLSchemes</key>
<array>
<string>{{yourapp-payment}}</string>
</array>
</dict>
</array>Install
npm install aigens-sdk-anz-tap-mobile
npx cap syncAPI
startPayment(...)
startPayment(options: ANZStartPaymentOptions) => Promise<ANZStartPaymentResult>| Param | Type |
| ------------- | ------------------------------------------------------------------------- |
| options | ANZStartPaymentOptions |
Returns: Promise<ANZStartPaymentResult>
isInstalledApp(...)
isInstalledApp(options: { key: string; }) => Promise<{ install: boolean; }>| Param | Type |
| ------------- | ----------------------------- |
| options | { key: string; } |
Returns: Promise<{ install: boolean; }>
checkNFCIsWorking()
checkNFCIsWorking() => Promise<{ supported: boolean; enabled: boolean; message?: string; }>Returns: Promise<{ supported: boolean; enabled: boolean; message?: string; }>
Interfaces
ANZStartPaymentResult
| Prop | Type | Description |
| ------------------- | ------------------- | ------------------------------------------------------------------------------------------- |
| status | string | Payment status returned by Tap on Mobile, e.g., "SUCCESS", "FAILED", "CANCELLED", "UNKNOWN" |
| transactionId | string | Transaction ID from Tap on Mobile result (if available) |
ANZStartPaymentOptions
| Prop | Type | Description |
| -------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------- |
| amount | number | Payment amount in smallest currency unit (e.g., 1000 = $10.00) |
| reference | string | Transaction reference |
| currency | string | ISO currency code, defaults to "AUD" |
| action | string | Optional: custom intent action, defaults to "com.worldline.taponmobile.PAYMENT" |
| appPackageName | string | Optional: fallback package name for redirect if app not installed, defaults to "com.worldline.taponmobile" |
| urlScheme | string | Optional: custom URL scheme for payment return |
