Appendix: Quick Reference Tables

The NMI Payment Device SDK provides asynchronous callbacks to handle device updates, transaction flow, and error handling. Below is a categorized reference.

CallbackPurposeNext Action
onAvailablePinPadsReturns available readersSelect device & connect
onConnectAndConfigureFinishedReady to transactStart transaction
onTransactionUpdateEMV progress updatesUpdate UI
onTransactionFinishedTransaction completeConfirm/Void
onSignatureVerificationSignature requiredCall continueSignatureVerification()
onDeferredAuthorizationOffline fallback possibleCall continueDeferredAuthorization()
onProcessReceiptFinishedReceipt deliveredLog result

The following optional startTransaction() parameters store a card for later use. See Payment Methods for details.

ParameterValuesUsed for
CustomerVaultCommandadd-customer, update-customerCustomer Vault
CustomerVaultIdVault record ID, up to 199 charactersCustomer Vault
CredentialOnFileFirstStoreTRUECredential on File, Incremental Authorization
CredentialOnFileReasonA reason, such as ReasonUnscheduledCredential on File; ReasonIncremental for Incremental Authorization

On iOS, the parameter keys are prefixed CCParam (for example CCParamCustomerVaultCommand) and the reason values CCValue (for example CCValueReasonIncremental).


Did this page help you?