Methods

Below is a list of available methods in the myPOS Payment API, grouped by their function. Each method includes a brief description of its purpose and whether customer interaction is required.

MethodGroupDescription
PURCHASEFinancialInitiate a purchase/sale or preauthorization procedure in the terminal. Customer interaction required.
COMPLETE_TXFinancialInitiate a settlement/receipt procedure in the terminal. No customer interaction needed.
CANCEL_TXFinancialInitiate an automatic reversal of a successfully processed purchase/sale procedure that is not yet completed. No customer interaction needed.
COMPLETE_PREAUTHFinancialInitiate a settlement/receipt procedure for a previously processed preauthorization. No customer interaction needed.
CANCEL_PREAUTHFinancialInitiate an automatic reversal of a successfully processed preauthorization that is not yet completed. No customer interaction needed.
REVERSALFinancialInitiate a reversal/void procedure of the last transaction. No customer interaction needed.
REFUNDFinancialInitiate a refund/credit to cardholder procedure in the terminal. Customer interaction required.
GET_STATUSStatusReturns the status of the terminal or the status and details of a previously executed payment. No customer interaction needed.
PRINT_EXTPrintPrint a receipt on the terminal printer.
ACTIVATESystemActivate the device.
UPDATESystemUpdate the device software.
REPRINT_RECEIPTPrintReprint the last transaction receipt.
DEACTIVATESystemDeactivate the device (reset settings to defaults).
GET_CERTIFICATESystemReturns the certificate for a specified (requested) fingerprint.
INITSystemUsed by the POS terminal to send its parameters and check if a working service is connected.
END INITSystemUsed by the service to inform the POS terminal of successful initialization of the previous method.
PROCESSSystemUsed when the POS will inform the service that it will be busy and unable to respond to other requests.