- 23 Oct 2024
- 1 Minute to read
- DarkLight
Exposed APIs of the Orchestration SDK: Local Transaction
- Updated on 23 Oct 2024
- 1 Minute to read
- DarkLight
New APIs are created for Swift users of the iOS SDK. For more information, refer to the Xcode API documentation on LocalTransactionParameters and LocalTransactionDelegate.
The Customer Mobile Application can initialize a local transaction process by calling the startLocalTransaction method of the Orchestrator object.
A LocalTransactionParams object must be provided as an input parameter of the startLocalTransaction method; this LocalTransactionParams object must be initiated with the following parameters:
User identifier. A string which uniquely identifies the user on the OneSpan Trusted Identity platform.
Cryptographic Application Index. The index of the cryptographic application which must be used to generate the signature.
Data Fields. The transaction data to sign. A list of max. 8 data fields; the length of the data fields is limited to 16 characters.
Protection Type. The authentication method which must be used to authenticate the user before signing the transaction (see Authentication methods for more information).
The LocalTransactionCallback interface is used by the Orchestration SDK to interact with the Customer Mobile Application during the local transaction process. It exposes the following methods:
onLocalTransactionSuccess. Called upon local transaction success. It returns the generated signature and, depending on the Digipass configuration, a host code (used to authenticate the authentication server on which the signature has been submitted).
onLocalTransactionAborted. Called when local transaction is cancelled.
onLocalTransactionPasswordError. Called upon a local transaction process error due to incorrect user input. The possible errors are listed in the OrchestrationErrorCodes class.
For more information about this feature, see Local transaction.