co.poynt.os.services.v1

Interface IPoyntTransactionService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntTransactionService.Stub

public interface IPoyntTransactionService
extends android.os.IInterface

Provides necessary interfaces to create and manage Transactions. All operations require network connectivity except for the 'get' operations, in which case, data from the local Poynt Transactions content providerName is returned. Poynt Transactions content providerName is updated whenever the transaction are modified locally or on the cloud. All calls require the necessary permissions declared in the caller's Android Manifest file. Please refer to Poynt OS Permissions for more details.

Since:

1.0-beta2

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	captureAllTransactions(java.lang.String requestId) Captures all authorized transactions through Poynt Cloud
void	captureAllTransactionsWithOptions(java.lang.String requestId, android.os.Bundle options, co.poynt.api.model.CaptureAllRequest captureAll, IPoyntTransactionCaptureAllListener listener) Captures all authorized transactions through Poynt Cloud
void	captureEmvData(java.lang.String transactionId, co.poynt.api.model.EMVData emvData, java.lang.String requestId) Record EMV Data (Tags) for settlement purpose (ODC/BDC)
void	captureTransaction(java.lang.String transactionId, co.poynt.api.model.AdjustTransactionRequest captureRequest, java.lang.String requestId, IPoyntTransactionServiceListener callback) Captures the transactions through Poynt Cloud and also updates the transaction in local Poynt Order content providerName.
void	checkCard(Payment payment, java.lang.String serviceCode, java.lang.String cardHolderName, java.lang.String expirationDate, java.lang.String last4, java.lang.String binRange, java.lang.String AID, java.lang.String applicationLabel, java.lang.String panSequenceNumber, java.lang.String issuerCountryCode, java.lang.String encryptedPAN, java.lang.String encryptedTrack2, int issuerCodeTableIndex, java.lang.String applicationPreferredName, java.lang.String keyIdentifier, java.lang.String appCurrencyCode, IPoyntCheckCardListener callback) Check the card data to determine if the transaction can be continued or canceled or to be restarted with a different parameters (amount, etc.)
void	createTransaction(co.poynt.api.model.Transaction transaction, java.lang.String requestId, IPoyntTransactionServiceListener callback) Creates the transaction in Poynt Cloud and also saves the created transaction in Poynt Transaction content providerName.
void	getBalanceInquiry(co.poynt.api.model.BalanceInquiry balanceInquiry, java.lang.String requestId, IPoyntTransactionBalanceInquiryListener callBack)
void	getTransaction(java.lang.String transactionId, java.lang.String requestId, IPoyntTransactionServiceListener callback) Retrieves the given transaction from the local Poynt Transaction content providerName if available, otherwise fetches from the Poynt Cloud .
void	processTransaction(co.poynt.api.model.Transaction transaction, java.lang.String requestId, IPoyntTransactionServiceListener callback) Processes the given transaction through Poynt Cloud and also saves the processed transaction in local Poynt Transaction content providerName.
void	reverseTransaction(java.lang.String originalRequestId, java.lang.String originalTransactionId, co.poynt.api.model.EMVData emvData, java.lang.String requestId) Cancels the given requestId in the Poynt Cloud and updates local Poynt Transaction content providerName.
void	saveTransaction(co.poynt.api.model.Transaction transaction, java.lang.String requestId) Saves a given transaction in Poynt Content Provider.
void	updateTransaction(java.lang.String transactionId, co.poynt.api.model.AdjustTransactionRequest updateRequest, java.lang.String requestId, IPoyntTransactionServiceListener callback) Updates the given transaction in the Poynt Cloud and updates local Poynt Transaction content providerName.
void	voidTransaction(java.lang.String transactionId, co.poynt.api.model.EMVData emvData, java.lang.String requestId, IPoyntTransactionServiceListener callback) Voids any pending authorizations through Poynt Cloud and also updates the transaction in local Poynt Transaction content providerName.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

createTransaction

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

Creates the transaction in Poynt Cloud and also saves the created transaction in Poynt Transaction content providerName. This interface only creates the transaction and does not process it.

Parameters:

transaction - co.poynt.api.Transaction

requestId - RequestId for Idempotency enforcement

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

processTransaction

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

Processes the given transaction through Poynt Cloud and also saves the processed transaction in local Poynt Transaction content providerName.

Parameters:

transaction - co.poynt.api.Transaction

requestId - RequestId for Idempotency enforcement

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

voidTransaction

void voidTransaction(java.lang.String transactionId,
                     co.poynt.api.model.EMVData emvData,
                     java.lang.String requestId,
                     IPoyntTransactionServiceListener callback)
              throws android.os.RemoteException

Voids any pending authorizations through Poynt Cloud and also updates the transaction in local Poynt Transaction content providerName.

Parameters:

transactionId - ID of the transaction to void

requestId - RequestId for Idempotency enforcement

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

captureTransaction

void captureTransaction(java.lang.String transactionId,
                        co.poynt.api.model.AdjustTransactionRequest captureRequest,
                        java.lang.String requestId,
                        IPoyntTransactionServiceListener callback)
                 throws android.os.RemoteException

Captures the transactions through Poynt Cloud and also updates the transaction in local Poynt Order content providerName. When partial payment captures are required, an co.poynt.api.AdjustTransactionRequest object with the partial capture information can be passed as an argument. When only transactionId is provided, the payment is captured completely.

Parameters:

transactionId - ID of the transaction to capture

captureRequest - co.poynt.api.AdjustTransactionRequest

requestId - RequestId for Idempotency enforcement

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

captureAllTransactions

void captureAllTransactions(java.lang.String requestId)
                     throws android.os.RemoteException

Captures all authorized transactions through Poynt Cloud

Parameters:

requestId - RequestId for Idempotency enforcement

Throws:

android.os.RemoteException

updateTransaction

void updateTransaction(java.lang.String transactionId,
                       co.poynt.api.model.AdjustTransactionRequest updateRequest,
                       java.lang.String requestId,
                       IPoyntTransactionServiceListener callback)
                throws android.os.RemoteException

Updates the given transaction in the Poynt Cloud and updates local Poynt Transaction content providerName.

Parameters:

transactionId - ID of the transaction to update

updateRequest - AdjustTransactionRequest

requestId - RequestId for Idempotency enforcement

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

reverseTransaction

void reverseTransaction(java.lang.String originalRequestId,
                        java.lang.String originalTransactionId,
                        co.poynt.api.model.EMVData emvData,
                        java.lang.String requestId)
                 throws android.os.RemoteException

Cancels the given requestId in the Poynt Cloud and updates local Poynt Transaction content providerName.

Parameters:

originalRequestId - requesTId of the original transaction request to cancel

originalTransactionId - transactionId of the original transaction to cancel

emvData - EMVData

requestId - RequestId for Idempotency enforcement

Throws:

android.os.RemoteException

getTransaction

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

Retrieves the given transaction from the local Poynt Transaction content providerName if available, otherwise fetches from the Poynt Cloud .

Parameters:

transactionId - ID of the Transaction to retrieve

requestId - RequestId for tracking the request

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

saveTransaction

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

Saves a given transaction in Poynt Content Provider. This interface only saves locally.

Parameters:

transaction - co.poynt.api.Transaction

requestId - RequestId for Idempotency enforcement

callback - IPoyntTransactionServiceListener

Throws:

android.os.RemoteException

checkCard

void checkCard(Payment payment,
               java.lang.String serviceCode,
               java.lang.String cardHolderName,
               java.lang.String expirationDate,
               java.lang.String last4,
               java.lang.String binRange,
               java.lang.String AID,
               java.lang.String applicationLabel,
               java.lang.String panSequenceNumber,
               java.lang.String issuerCountryCode,
               java.lang.String encryptedPAN,
               java.lang.String encryptedTrack2,
               int issuerCodeTableIndex,
               java.lang.String applicationPreferredName,
               java.lang.String keyIdentifier,
               java.lang.String appCurrencyCode,
               IPoyntCheckCardListener callback)
        throws android.os.RemoteException

Check the card data to determine if the transaction can be continued or canceled or to be restarted with a different parameters (amount, etc.)

Parameters:

payment - Payment

service - code

card - holder name

expirationDate -

last4 - digits of the PAN

bin - range of the PAN

Application - Id

Application - label

pan - Sequence number

issuer - country code

encrypted - PAN

encryptedTrack2 - Encrypted Track2

issuerCodeTableIndex - code table according to ISO/IEC 8859 for displaying the Application Preferred Name

applicationPreferredName - Application Preferred Name

keyIdentifier - carries Key Serial Number when DUKPT scheme is used or Session Key ID when Master/Sessin key scheme is used

appCurrencyCode - the Application currency code

callback - IPoyntCheckCardListener

Throws:

android.os.RemoteException

captureEmvData

void captureEmvData(java.lang.String transactionId,
                    co.poynt.api.model.EMVData emvData,
                    java.lang.String requestId)
             throws android.os.RemoteException

Record EMV Data (Tags) for settlement purpose (ODC/BDC)

Parameters:

transactionId - ID of the transaction to void

emvData - EMVData

requestId - RequestId for Idempotency enforcement

Throws:

android.os.RemoteException

getBalanceInquiry

void getBalanceInquiry(co.poynt.api.model.BalanceInquiry balanceInquiry,
                       java.lang.String requestId,
                       IPoyntTransactionBalanceInquiryListener callBack)
                throws android.os.RemoteException

Throws:

android.os.RemoteException

captureAllTransactionsWithOptions

void captureAllTransactionsWithOptions(java.lang.String requestId,
                                       android.os.Bundle options,
                                       co.poynt.api.model.CaptureAllRequest captureAll,
                                       IPoyntTransactionCaptureAllListener listener)
                                throws android.os.RemoteException

Captures all authorized transactions through Poynt Cloud

Parameters:

requestId - RequestId for Idempotency enforcement

options - Bundle can contain the following:

INCLUDE_AUTHONLY: String "TRUE" or "FALSE"(defaults to false if not passed). Determines whether to include or exclude authOnly transactions ALL_TIDS: String "TRUE" or "FALSE"(defaults to false if not passed). If TRUE, captures and settles transactions for all terminals in the store

listener - CaptureAllRequest captureAll. This param is ignored if ALL_TIDS is set to TRUE in the options Bundle.

listener - IPoyntTransactionCaptureAllListener callback to provide the list of accepted transactions

Throws:

android.os.RemoteException