@tass-tech/capacitor-redeban-qr
v1.2.6
Published
Implementación el SDK del QR de Redeban para las transferencias interbancarias.
Readme
@tass-tech/capacitor-redeban-qr
Implementación del SDK del QR de Redeban para las transferencias interbancarias.
| Nombre | Versión | |-------------|-----------| | Node | v20 | | Capacitor | v7 | | SDK Redeban | v1.1.2 | | Plugin | > v1.0.0 |
Instalación Local
- Instalar el respositorio en la siguiente carpeta (En caso de no existir, crearla).
plugins > @tass-tech
- Alojar y asegurar el SDK de Redeban en las carpetas correpondientes con los nombres indicados.
- Android:
android > libs > sdkqrcore-release.aar - iOS:
ios > Frameworks > SdkQrCore.xcframework
- Android:
Instalación por NPM
npm install @tass-tech/capacitor-redeban-qr
npx cap syncAPI
initSdkQrLibrary(...)startImageScan(...)startCameraScan()startCameraScanOverlay(...)closeCameraOverlay()- Interfaces
- Type Aliases
initSdkQrLibrary(...)
initSdkQrLibrary(options: IInitPluginOptions) => Promise<{ isInitialized: boolean; }>Inicializacion de libreria para el procesamiento de los codigos QR.
| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| options | IInitPluginOptions |
Returns: Promise<{ isInitialized: boolean; }>
Since: 0.1.0
startImageScan(...)
startImageScan(options: { input: string; }) => Promise<IScanResponse>Metodo que permite el escaneo y procesamiento del QR con estandar EMVCo a partir de una imagen.
| Param | Type |
| ------------- | ------------------------------- |
| options | { input: string; } |
Returns: Promise<IScanResponse>
Since: 1.1.0
startCameraScan()
startCameraScan() => Promise<IScanResponse>Metodo que permite el escaneo y procesamiento del QR con estandar EMVCo a partir de la captura de la camara.
Returns: Promise<IScanResponse>
Since: 0.1.0
startCameraScanOverlay(...)
startCameraScanOverlay(options: { width?: number; height?: number; x?: number; y?: number; }) => Promise<IScanResponse>Metodo que permite el escaneo y procesamiento del QR con estandar EMVCo a partir de la captura de la camara embebida en un overlay personalizado (una snapshot de la vista Ionic).
| Param | Type |
| ------------- | ------------------------------------------------------------------------- |
| options | { width?: number; height?: number; x?: number; y?: number; } |
Returns: Promise<IScanResponse>
Since: 1.2.0
closeCameraOverlay()
closeCameraOverlay() => Promise<void>Metodo que permite el cerrar el escaneo con overlay.
Since: 1.2.0
Interfaces
IInitPluginOptions
| Prop | Type |
| --------------- | -------------------- |
| urlBase | string |
| publicKey | string |
| license | string |
| debug | boolean |
IScanResponse
| Prop | Type | Description | Since |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ----- |
| merchantData | { merchantName: string; totalAmount: string | null; customerLabel: string | null; idAcquirer: string; uniqueCodeMerchant: string; typeKey: TypeKey; } | Información del comercio y transacción asociada al QR escaneado. | 0.0.1 |
| typeQR | 'static' | 'dynamic' | Tipo de QR escaneado, puede ser estático o dinámico. | 0.0.2 |
| dataMap | string | String con los datos del medio de acceso para referenciar la transacción. | 0.0.2 |
| selectorMode | { transactionId: string; idNetworkAdquirer: string; channel: string; rrn: number; approvalNumber: number; securityCode: string; storeLabel: string; transactionAmount: number; currencyCode: string; purposeOfTransaction: string; terminal: string; merchantId: string; partySystemIdentifier: string; partyIdentifier: string; } | Información adicional del Selector Mode para transacciones dinámicas. | 0.3.0 |
Type Aliases
TypeKey
'MSISDN' | 'MERCHANTID' | 'EMAIL' | 'ALIAS' | 'USERIDENTIFICATION'
