PPRetailTransactionManager Class Reference

Inherits from PPRetailObject : NSObject
Declared in PPRetailTransactionManager.h

Overview

TransactionManager is a public facing facade to everything related to a Transaction.

– createTransaction:callback:

Create a transaction using the provided Invoice. An existing transaction will be canceled

- (void)createTransaction:(PPRetailRetailInvoice *_Nullable)invoice callback:(PPRetailTransactionManagerTransactionHandler _Nullable)callback

Discussion

Create a transaction using the provided Invoice. An existing transaction will be canceled

Declared In

PPRetailTransactionManager.h

– createVaultTransaction:

Create a vault.

- (void)createVaultTransaction:(PPRetailTransactionManagerTransactionHandler _Nullable)callback

Discussion

Create a vault.

Declared In

PPRetailTransactionManager.h

– createRefundTransaction:transactionNumber:paymentMethod:callback:

Create a refund transaction. An existing transaction will be canceled. Note: Refunds can be performed using invoiceId alone using createRefundTransactionWithInvoiceId. And refunds can also be performed with transactionNumber alone using createRefundTransactionWithTransactionNumber.

- (void)createRefundTransaction:(NSString *_Nullable)invoiceId transactionNumber:(NSString *_Nullable)transactionNumber paymentMethod:(PPRetailInvoicePaymentMethod)paymentMethod callback:(PPRetailTransactionManagerTransactionHandler _Nullable)callback

Discussion

Create a refund transaction. An existing transaction will be canceled. Note: Refunds can be performed using invoiceId alone using createRefundTransactionWithInvoiceId. And refunds can also be performed with transactionNumber alone using createRefundTransactionWithTransactionNumber.

Declared In

PPRetailTransactionManager.h

– createCashOrCheckRefundTransaction:callback:

Simplified cash or check refund with invoiceId. An existing transaction will be canceled.

- (void)createCashOrCheckRefundTransaction:(NSString *_Nullable)invoiceId callback:(PPRetailTransactionManagerTransactionHandler _Nullable)callback

Discussion

Simplified cash or check refund with invoiceId. An existing transaction will be canceled.

Declared In

PPRetailTransactionManager.h

– createCardRefundTransaction:callback:

Simplified card refund with invoiceId. An existing transaction will be canceled.

- (void)createCardRefundTransaction:(NSString *_Nullable)invoiceId callback:(PPRetailTransactionManagerTransactionHandler _Nullable)callback

Discussion

Simplified card refund with invoiceId. An existing transaction will be canceled.

Declared In

PPRetailTransactionManager.h

– startOfflinePayment:

Enable the offline payment flag and start the offline payment process if needed

- (void)startOfflinePayment:(PPRetailTransactionManagerOfflinePaymentStatusHandler _Nullable)callback

Discussion

Enable the offline payment flag and start the offline payment process if needed

Declared In

PPRetailTransactionManager.h

– getOfflinePaymentEligibility

Get offline payment eligibility for the merchant

- (BOOL)getOfflinePaymentEligibility

Discussion

Get offline payment eligibility for the merchant

Declared In

PPRetailTransactionManager.h

– getQRCEligibility

Get QRC payment eligibility for the merchant

- (BOOL)getQRCEligibility

Discussion

Get QRC payment eligibility for the merchant

Declared In

PPRetailTransactionManager.h

– stopOfflinePayment:

disable the offline payment flag

- (void)stopOfflinePayment:(PPRetailTransactionManagerOfflinePaymentStatusHandler _Nullable)callback

Discussion

disable the offline payment flag

Declared In

PPRetailTransactionManager.h

– startReplayOfflineTxns:

start the replay of the offline txns saved

- (void)startReplayOfflineTxns:(PPRetailTransactionManagerOfflinePaymentStatusHandler _Nullable)callback

Discussion

start the replay of the offline txns saved

Declared In

PPRetailTransactionManager.h

– stopReplayOfflineTxns:

stop the replay of the offline txns saved

- (void)stopReplayOfflineTxns:(PPRetailTransactionManagerOfflinePaymentStatusHandler _Nullable)callback

Discussion

stop the replay of the offline txns saved

Declared In

PPRetailTransactionManager.h

– getOfflinePaymentStatus:

get the status of offline payment txns

- (void)getOfflinePaymentStatus:(PPRetailTransactionManagerOfflinePaymentStatusHandler _Nullable)callback

Discussion

get the status of offline payment txns

Declared In

PPRetailTransactionManager.h

– getOfflinePaymentEnabled

Enable the offline payment flag

- (BOOL)getOfflinePaymentEnabled

Discussion

Enable the offline payment flag

Declared In

PPRetailTransactionManager.h

– getSupportedQRCProviders

Returns the list of supported QRC service providers

- (NSArray *_Nullable)getSupportedQRCProviders

Discussion

Returns the list of supported QRC service providers

Declared In

PPRetailTransactionManager.h

– getCurrentTransactionContext

Get the current transaction context

- (PPRetailTransactionContext *_Nullable)getCurrentTransactionContext

Discussion

Get the current transaction context

Declared In

PPRetailTransactionManager.h

– retrieveAuthorization:endDateTime:pageSize:status:callback:

Retrieve the list of authorized transactions.

- (void)retrieveAuthorization:(NSDate *_Nullable)startDateTime endDateTime:(NSDate *_Nullable)endDateTime pageSize:(int)pageSize status:(NSArray *_Nullable)status callback:(PPRetailTransactionManagerRetrieveAuthorizedTransactionsHandler _Nullable)callback

Discussion

Retrieve the list of authorized transactions.

Declared In

PPRetailTransactionManager.h

– retrieveAuthorizationUsingToken:callback:

Retrieve the next list of authorized transactions using the nextPageToken.

- (void)retrieveAuthorizationUsingToken:(NSString *_Nullable)nextPageToken callback:(PPRetailTransactionManagerRetrieveAuthorizedTransactionsHandler _Nullable)callback

Discussion

Retrieve the next list of authorized transactions using the nextPageToken.

Declared In

PPRetailTransactionManager.h

– voidAuthorization:callback:

Void an authorized transaction

- (void)voidAuthorization:(NSString *_Nullable)authorizationId callback:(PPRetailTransactionManagerVoidAuthorizationHandler _Nullable)callback

Discussion

Void an authorized transaction

Declared In

PPRetailTransactionManager.h

– captureAuthorization:invoiceId:totalAmount:gratuityAmount:currency:callback:

Capture a previously authorized transaction.

- (void)captureAuthorization:(NSString *_Nullable)authorizationId invoiceId:(NSString *_Nullable)invoiceId totalAmount:(NSDecimalNumber *_Nullable)totalAmount gratuityAmount:(NSDecimalNumber *_Nullable)gratuityAmount currency:(NSString *_Nullable)currency callback:(PPRetailTransactionManagerCaptureAuthorizedTransactionHandler _Nullable)callback

Discussion

Capture a previously authorized transaction.

Declared In

PPRetailTransactionManager.h

– captureAuthorization:invoiceId:totalAmount:gratuityAmount:currency:base64SignatureJpeg:callback:

Capture a previously authorized transaction.

- (void)captureAuthorization:(NSString *_Nullable)authorizationId invoiceId:(NSString *_Nullable)invoiceId totalAmount:(NSDecimalNumber *_Nullable)totalAmount gratuityAmount:(NSDecimalNumber *_Nullable)gratuityAmount currency:(NSString *_Nullable)currency base64SignatureJpeg:(NSString *_Nullable)base64SignatureJpeg callback:(PPRetailTransactionManagerCaptureAuthorizedTransactionHandler _Nullable)callback

Discussion

Capture a previously authorized transaction.

Declared In

PPRetailTransactionManager.h