co.poynt.os.services.v1

Interface IPoyntCustomLoyaltyService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntCustomLoyaltyService.Stub

public interface IPoyntCustomLoyaltyService
extends android.os.IInterface

Provides necessary interfaces to support customer account on Poynt devices. Typical integration includes the following steps:

All calls require android:permission="co.poynt.capability.PAYMENT" to be declared in the caller's Android Manifest file. Please refer to Poynt OS Permissions for more details. All implementers of this Service must add meta data to the 'Service' element in their Android Manifest file for Poynt to recognize and invoke your service as needed. Here's the example service declaration in AndroidManifest.xml

 
  Sample Service
         <service
             android:name=".CustomLoyaltyService"
             android:enabled="true"
             android:exported="true"
             android:permission="co.poynt.capability.PAYMENT">

             <!-- define the intent filter with an action as IPoyntCustomLoyaltyService interface -->
             <intent-filter>
                 <action android:name="co.poynt.os.services.v1.IPoyntCustomLoyaltyService" />
             </intent-filter>

             <meta-data
                 android:name="co.poynt.os.service.capability"
                 android:resource="@xml/loyalty_capabilities"/>

             <!-- Optional: Provide a logo that will appear on screen -->
             <meta-data
                 android:name="co.poynt.os.service.logo"
                 android:resource="@drawable/custom_tender" />
         </service>

  Sample Loyalty XML
        <?xml version="1.0" encoding="utf-8"?>
        <!-- This xml defines what capabilities are supported by the service that uses this xml.
          Capabilities will be used by PoyntOS to produce custom UI on behalf of the service to
          get inputs from merchant/customer. -->
        <capability xmlns:android="http://schemas.android.com/apk/res/android">

            <!-- REQUIRED: application id of this app
                 this appid is issued by poynt web portal
                 IMPORTANT: Replace this appid with your appid.-->
            <!--<appid>urn:aid:0f39b7a3-b9db-41f1-9cdb-9f04a3620ade</appid>-->
            <appid>urn:aid:d3462a56-737b-4419-b54c-39a59f4dc8d6</appid>

            <!-- REQUIRED: type of capbility, should be one of
                    CUSTOM_TRANSACTION, DISCOUNT, LOYALTY,
                    please see CapabilityType defined in PoyntSDK for list of types supported.
            -->
            <type>LOYALTY</type>

            <!-- descriptive name of this capability -->
            <provider>Poynt Loyalty</provider>>

            <!-- entry method could be one of the following
                MANUAL -> will result in showing a icon to the merchant to manually launch the capability.
                CARDREAD -> card data will be directly passed to this capability provider.
                QRCODE -> qr code entry.
                NFC -> NFC will be directly passed  to this capability provider.
                OTHER -> other entry methods.
                each entry method can be additionally filtered with eval tag.
            -->
            <entry_method type="MANUAL"></entry_method>

        </capability>
 
 

Since:

beta3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPoyntCustomLoyaltyService.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
void	getAccount(java.lang.String requestId, java.lang.String customerId, IPoyntCustomLoyaltyServiceListener callback) Get Customer Account based on the given accountId.
void	lookupAccount(java.lang.String requestId, java.lang.String identifier, IPoyntCustomLoyaltyServiceListener callback) Lookup customer account based on the given identifier.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

lookupAccount

void lookupAccount(java.lang.String requestId,
                   java.lang.String identifier,
                   IPoyntCustomLoyaltyServiceListener callback)
            throws android.os.RemoteException

Lookup customer account based on the given identifier. The identifier could be an account number (PAN), a scanned code, or an alpha-numeric identifier like a loginId/email/Phone etc.

Parameters:

identifier - Identifier entered by customer

callback - IPoyntCustomLoyaltyServiceListener

Throws:

android.os.RemoteException

getAccount

void getAccount(java.lang.String requestId,
                java.lang.String customerId,
                IPoyntCustomLoyaltyServiceListener callback)
         throws android.os.RemoteException

Get Customer Account based on the given accountId.

Parameters:

customerId - Customer Account ID

callback - IPoyntCustomLoyaltyServiceListener

Throws:

android.os.RemoteException