co.poynt.os.services.v1

Interface IPoyntCustomTransactionService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntCustomTransactionService.Stub

public interface IPoyntCustomTransactionService
extends android.os.IInterface

Provides necessary interfaces to support custom payment methods on Poynt devices. These custom payment methods include mobile wallets, gift card etc. 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 that implements custom tender payment service. -->
        <service
            android:name=".CustomPaymentService"
            android:enabled="true"
            android:exported="true"
            android:permission="co.poynt.capability.PAYMENT">

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

            <meta-data
                android:name="co.poynt.os.service.capability"
                android:resource="@xml/payment_gift_card_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 Custom tender 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>CUSTOM_TRANSACTION</type>

            <!-- descriptive name of this capability -->
            <provider>Poynt Gift Card</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.
                OTHER -> other entry methods.
                each entry method can be additionally filtered with eval tag.
            -->
            <entry_method type="MANUAL"></entry_method>

            <!-- value is a first6 digits of card number also refered to as binrange.
                value >=601056 && value <= 601056 -->
            <!-- for eval expression defination please refer to https://github.com/uklimaschewski/EvalEx -->
            <entry_method type="CARDREAD" eval="value &lt;= 60105 &amp;&amp; value &gt;=  60105" />

            </capability>
 
 

Since:

beta3

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	authorizeTransaction(java.lang.String requestId, co.poynt.api.model.Transaction transaction, IPoyntCustomTransactionServiceListener callback) Authorize the given Transaction and return a updated transaction by calling IPoyntCustomPaymentServiceListener#onSucess,
void	captureTransaction(java.lang.String requestId, java.lang.String transactionId, IPoyntCustomTransactionServiceListener callback) Mark the transaction as completed and update the status of the transaction as necessary.
void	getTransaction(java.lang.String requestId, java.lang.String transactionId, IPoyntCustomTransactionServiceListener callback) Retrieve the given custom transaction.
void	refundTransaction(java.lang.String requestId, co.poynt.api.model.Transaction transaction, IPoyntCustomTransactionServiceListener callback) Refund a completed transaction.
void	voidTransaction(java.lang.String requestId, java.lang.String transactionId, IPoyntCustomTransactionServiceListener callback) Void the given transaction that has not been processed yet.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

authorizeTransaction

void authorizeTransaction(java.lang.String requestId,
                          co.poynt.api.model.Transaction transaction,
                          IPoyntCustomTransactionServiceListener callback)
                   throws android.os.RemoteException

Authorize the given Transaction and return a updated transaction by calling IPoyntCustomPaymentServiceListener#onSucess,

Parameters:

requestId - Request id of the call originator.

transaction - object to authorize, modify the transaction object to add custom payment related information.

callback - IPoyntCustomPaymentServiceListener updated transaction is returned back.

Throws:

android.os.RemoteException

voidTransaction

void voidTransaction(java.lang.String requestId,
                     java.lang.String transactionId,
                     IPoyntCustomTransactionServiceListener callback)
              throws android.os.RemoteException

Void the given transaction that has not been processed yet.

Parameters:

requestId - requestID to identify void transaction.

transactionId - ID of the custom transaction transaction to void

callback - IPoyntCustomPaymentServiceListener

Throws:

android.os.RemoteException

captureTransaction

void captureTransaction(java.lang.String requestId,
                        java.lang.String transactionId,
                        IPoyntCustomTransactionServiceListener callback)
                 throws android.os.RemoteException

Mark the transaction as completed and update the status of the transaction as necessary. Return the updated transaction.

Parameters:

requestId - requestID to identify this transaction.

transactionId - ID of the custom transaction to capture

callback - IPoyntCustomDiscountCompleteListener

Throws:

android.os.RemoteException

refundTransaction

void refundTransaction(java.lang.String requestId,
                       co.poynt.api.model.Transaction transaction,
                       IPoyntCustomTransactionServiceListener callback)
                throws android.os.RemoteException

Refund a completed transaction.

Parameters:

requestId - requestID to identify this transaction.

transaction - object to refund.

callback - IPoyntCustomTenderServiceListener

Throws:

android.os.RemoteException

getTransaction

void getTransaction(java.lang.String requestId,
                    java.lang.String transactionId,
                    IPoyntCustomTransactionServiceListener callback)
             throws android.os.RemoteException

Retrieve the given custom transaction.

Parameters:

transactionId - ID of the custom transaction to retrieve

callback - IPoyntCustomTenderServiceListener

Throws:

android.os.RemoteException