co.poynt.os.services.v1

Interface IPoyntOrderService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntOrderService.Stub

public interface IPoyntOrderService
extends android.os.IInterface

Provides necessary interfaces to create and manage Orders. All operations require network connectivity except for the 'get' operations, in which case, data from the local Poynt Orders content providerName is returned. Poynt Order content providerName is updated whenever the orders 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	IPoyntOrderService.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
void	cancelOrder(java.lang.String orderId, java.lang.String requestId, IPoyntOrderServiceListener callback) Cancels the given order through Poynt Cloud and also updates the order in local Poynt Order content providerName.
void	captureOrder(java.lang.String orderId, co.poynt.api.model.Order order, java.lang.String requestId, IPoyntOrderServiceListener callback) Captures the payment transactions associated with the given order through Poynt Cloud and also updates the order in local Poynt Order content providerName.
void	completeOrder(java.lang.String orderId, co.poynt.api.model.Order order, java.lang.String requestId, IPoyntOrderServiceListener callback) Captures the payment transactions associated with the given order and marks the oder as Completed.
void	createOrder(co.poynt.api.model.Order order, java.lang.String requestId, IPoyntOrderServiceListener callback) Creates the order in Poynt Cloud and also saves the created order in Poynt Order content providerName.
void	getOrder(java.lang.String orderId, java.lang.String requestId, IPoyntOrderServiceListener callback) Retrieves the given order from the local Poynt Order content providerName if available, otherwise fetches from the Poynt Cloud .
void	processOrder(co.poynt.api.model.Order order, java.lang.String requestId, IPoyntOrderServiceListener callback) Processes the given order through Poynt Cloud and also saves the processed order in local Poynt Order content providerName.
void	saveOrder(co.poynt.api.model.Order order, java.lang.String requestId, IPoyntOrderServiceListener callback) Saves the given order in local Poynt Order content provider.
void	updateOrder(java.lang.String orderId, co.poynt.api.model.Order order, java.lang.String requestId, IPoyntOrderServiceListener callback) Updates the given order in the Poynt Cloud and updates local Poynt Order content providerName.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

saveOrder

void saveOrder(co.poynt.api.model.Order order,
               java.lang.String requestId,
               IPoyntOrderServiceListener callback)
        throws android.os.RemoteException

Saves the given order in local Poynt Order content provider. This interface only creates the order locally and does not sync with cloud. If no order->id is set, it will be assigned one, which will be returned in the response callback.

Parameters:

order - co.poynt.api.Order

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

createOrder

void createOrder(co.poynt.api.model.Order order,
                 java.lang.String requestId,
                 IPoyntOrderServiceListener callback)
          throws android.os.RemoteException

Creates the order in Poynt Cloud and also saves the created order in Poynt Order content providerName. This interface only creates the order and does not process any payment transactions (if any) specified in the Order object.

Parameters:

order - co.poynt.api.Order

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

processOrder

void processOrder(co.poynt.api.model.Order order,
                  java.lang.String requestId,
                  IPoyntOrderServiceListener callback)
           throws android.os.RemoteException

Processes the given order through Poynt Cloud and also saves the processed order in local Poynt Order content providerName. This interface processes any payment transactions specified in the Order object.

Parameters:

order - co.poynt.api.Order

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

cancelOrder

void cancelOrder(java.lang.String orderId,
                 java.lang.String requestId,
                 IPoyntOrderServiceListener callback)
          throws android.os.RemoteException

Cancels the given order through Poynt Cloud and also updates the order in local Poynt Order content providerName. This interface refunds or voids any transactions that are part of the original Order.

Parameters:

order - co.poynt.api.Order

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

captureOrder

void captureOrder(java.lang.String orderId,
                  co.poynt.api.model.Order order,
                  java.lang.String requestId,
                  IPoyntOrderServiceListener callback)
           throws android.os.RemoteException

Captures the payment transactions associated with the given order through Poynt Cloud and also updates the order in local Poynt Order content providerName. When partial payment captures are required, an order object with the partial capture information can be passed as an argument. When only orderId is provided, the payments are captured completely.

Parameters:

orderId - ID of the order to capture

order - co.poynt.api.Order

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

completeOrder

void completeOrder(java.lang.String orderId,
                   co.poynt.api.model.Order order,
                   java.lang.String requestId,
                   IPoyntOrderServiceListener callback)
            throws android.os.RemoteException

Captures the payment transactions associated with the given order and marks the oder as Completed. Order is processed through Poynt Cloud and also updated in the local Poynt Order content providerName. When partial payment captures are required, an order object with the partial capture information can be passed as an argument. When only orderId is provided, the payments are captured completely.

Parameters:

orderId - ID of the order to capture

order - co.poynt.api.Order - if not null and order.getContext().getSource equals to TransactionSource.WEB the server will mark order items as FULFILLED

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

getOrder

void getOrder(java.lang.String orderId,
              java.lang.String requestId,
              IPoyntOrderServiceListener callback)
       throws android.os.RemoteException

Retrieves the given order from the local Poynt Order content providerName if available, otherwise fetches from the Poynt Cloud .

Parameters:

orderId - ID of the order to retrieve

requestId - RequestId for tracking the request

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException

updateOrder

void updateOrder(java.lang.String orderId,
                 co.poynt.api.model.Order order,
                 java.lang.String requestId,
                 IPoyntOrderServiceListener callback)
          throws android.os.RemoteException

Updates the given order in the Poynt Cloud and updates local Poynt Order content providerName.

Parameters:

orderId - ID of the order to update

order - Order

requestId - RequestId for Idempotency enforcement

callback - IPoyntOrderServiceListener

Throws:

android.os.RemoteException