{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Flute Mobile SDK for iOS","siteUrl":"https://developer.flute.com","description":"Documentation and API reference for integrating Flute payment processing.","lang":"en-US","llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"flute-mobile-sdk-for-ios","__idx":0},"children":["Flute Mobile SDK for iOS"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration Guide"]}," | Version 1.0.0 | March 23, 2026"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"changelog","__idx":1},"children":["Changelog"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":["Version"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Date"},"children":["Date"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What’s Changed"},"children":["What’s Changed"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1.0.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2026-01-21"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base version with Authentication, Payments, Settings, Device Info, Tap to Pay functionalities"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":2},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flute Mobile SDK for iOS enables developers to integrate Flute's payment processing capabilities directly into their iOS applications. Whether you're building a point-of-sale app, a mobile commerce platform, or adding payment acceptance to an existing business application, the SDK provides a comprehensive set of tools to handle the full transaction lifecycle."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"who-should-use-this-sdk","__idx":3},"children":["Who Should Use This SDK"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flute Mobile SDK is designed for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Independent Software Vendors (ISVs)"]}," building payment-enabled applications for merchants"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchants"]}," developing custom mobile point-of-sale solutions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Platform developers"]}," adding payment acceptance to marketplace or commerce apps"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"what-you-can-build","__idx":4},"children":["What You Can Build"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With the Flute Mobile SDK, you can create applications that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept contactless payments"]}," using Tap to Pay on iPhone — no external hardware required"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Process card-present and card-not-present transactions"]}," including sales, authorizations, captures, voids, and refunds"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Support flexible pricing models"]}," including ZCP (Zero Cost Processing) options like dual pricing, cash discounts, and credit card surcharges"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Manage transaction history"]}," with powerful filtering, pagination, and detailed reporting"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept tips"]}," with configurable tip options and calculations"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-features","__idx":5},"children":["Key Features"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"tap-to-pay-on-iphone","__idx":6},"children":["Tap to Pay on iPhone"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transform any compatible iPhone into a payment terminal. Customers can pay by holding their contactless credit card, debit card, Apple Pay, or other digital wallet just by tapping near the iPhone. No dongles, no external card readers — just the iPhone your merchants already carry."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"unified-transaction-api","__idx":7},"children":["Unified Transaction API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A single, consistent API surface for all transaction types. Whether you're authorizing a payment, capturing funds, or processing a refund, the SDK follows predictable patterns that reduce integration complexity."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"secure-by-design","__idx":8},"children":["Secure by Design"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK handles sensitive operations securely:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authentication tokens are stored in the iOS Keychain"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Token refresh is managed automatically in the background"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Card data is processed in compliance with PCI DSS requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tap to Pay leverages Apple's Secure Element for contactless transactions"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"zero-cost-processing-support","__idx":9},"children":["Zero Cost Processing Support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Built-in support for ZCP pricing models allows merchants to offset processing costs. The SDK provides amount calculation utilities that automatically apply surcharges or discounts based on payment method, ensuring accurate totals are displayed to customers before they pay."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"architecture-overview","__idx":10},"children":["Architecture Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK is organized into logical modules that map to common payment workflows:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Module"},"children":["Module"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Session Management"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Obtain and manage API access tokens"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transactions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit, query, and manage payment transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept contactless payments using iPhone's NFC"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve merchant configuration and payment options"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Device Management"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage registered devices and their Tap to Pay status"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"integration-patterns","__idx":11},"children":["Integration Patterns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK supports multiple integration approaches depending on your use case:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"simple-payment-flow","__idx":12},"children":["Simple Payment Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For straightforward payment acceptance, you can process a transaction in just a few lines:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n  // Initialize and authenticate\n  let ariseSdk = try AriseMobileSdk(environment: .uat)\n  try await ariseSdk.authenticate(clientId: \"your-client-id\", clientSecret: \" your-client-secret \")\n  // Process a Tap to Pay transaction\n     try await ariseSdk.ttp.prepare()\n     let result = try await ariseSdk.ttp.performTransaction(amount: 49.99)\n     print(\"Transaction \\(result.status): \\(result.transactionId ?? \"\")\")\n} catch {\n    // Unified error handling\n    print(\" An error occurred \\(error.localizedDescription)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"advanced-payment-flow","__idx":13},"children":["Advanced Payment Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For applications requiring more control — such as inline tips, surcharge calculations, or custom UI during card reading — the SDK provides granular methods and event streams to support complex workflows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"asynchronous-tasks-support","__idx":14},"children":["Asynchronous Tasks Support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK is built with Swift's modern concurrency model. All network operations and asynchronous tasks use async/await, making it easy to write clean, readable code without callback pyramids or manual thread management."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n    let settings = try await ariseSdk.getPaymentSettings()\n    let transactions = try await ariseSdk.getTransactions()\n    // Both calls complete sequentially with clear, linear code\n} catch {\n    // Unified error handling\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getting-help","__idx":15},"children":["Getting Help"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you encounter issues during integration:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Documentation"]},": Browse the complete API reference guide in the following sections."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Developer dashboard"]},": Visit developer.flute.com for additional API documentation and guides."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Support"]},": Contact Flute Payments developer support for technical assistance at developer@flute.com."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ready to start? Head to the Get Started section to set up your credentials and configure your development environment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-started","__idx":16},"children":["Get Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section guides you through the prerequisites and setup required before integrating the Flute Mobile SDK into your iOS application."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"obtain-client-credentials","__idx":17},"children":["Obtain Client Credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To authenticate with the Flute Mobile SDK, you need a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]},". The process differs depending on your relationship with Flute Payments."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"for-merchants","__idx":18},"children":["For Merchants"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.dev.flute.com"},"children":["Flute dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]}," | ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Tokens"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New API Token"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy both the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["⚠️ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important"]},": The Client Secret is displayed only once for security reasons. Store it securely immediately after generation. If you lose the secret, you will need to generate a new API token."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"for-affiliates--isv-partners","__idx":19},"children":["For Affiliates / ISV Partners"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can obtain credentials by accessing the Flute API using your partner credentials. First, follow the same steps above for creating your pair of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Then, use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant API Tokens"]}," endpoint to programmatically create and manage API tokens for your merchant accounts. See the Merchant API Tokens documentation for details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"environments","__idx":20},"children":["Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flute Mobile SDK supports two environments, specified during initialization:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Enum Value"},"children":["Enum Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Test environment for development and integration testing. Transactions are simulated and no real charges occur."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Live environment for real transactions. Cards will be charged and funds will be transferred."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sandbox-environment","__idx":21},"children":["Sandbox Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the sandbox environment during development and testing:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let ariseSdk = try AriseMobileSdk(environment: .uat)\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the sandbox mode:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["No real money is transferred"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Test card numbers can be used to simulate various scenarios, such as approvals, declines, and specific error codes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tap to pay can be tested with compatible devices"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All API functionality behaves identically to production"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Refer to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Testing"]}," section of this documentation for test card numbers, AVS test data, and instructions for simulating specific transaction outcomes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"production-environment","__idx":22},"children":["Production Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Production environment for connecting to real data and performing real transactions:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let ariseSdk = try AriseMobileSdk(environment: .production)\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["⚠️ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Warning"]},": In production mode, all transactions are real. Cards will be charged, and refunds will transfer actual funds. Ensure thorough testing in UAT before switching to production."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"system-requirements","__idx":23},"children":["System Requirements"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"minimum-ios-version","__idx":24},"children":["Minimum iOS Version"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Requirement"},"children":["Requirement"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":["Version"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["iOS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["18.0 or later"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5.0 or later"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"supported-devices","__idx":25},"children":["Supported Devices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK supports all iPhone models compatible with iOS 18. However, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tap to Pay on iPhone"]}," has additional device requirements:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Feature"},"children":["Feature"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Supported Devices"},"children":["Supported Devices"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["General SDK functionality"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All iPhones running iOS 18+"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay on iPhone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["iPhone XS or later"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"dependencies","__idx":26},"children":["Dependencies"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK includes the following dependencies, which are automatically resolved when you add the SDK to your project:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Library"},"children":["Library"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":["Version"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CryptoSwift"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1.8.2 – < 2.0.0"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift Certificates"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1.4.0 – < 2.0.0"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift ASN1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1.2.0 – < 2.0.0"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-entitlements-and-capabilities","__idx":27},"children":["Required Entitlements and Capabilities"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"for-general-integration","__idx":28},"children":["For General Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No special entitlements are required for basic SDK functionality (authentication, transaction submission, reporting)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"for-tap-to-pay-on-iphone","__idx":29},"children":["For Tap to Pay on iPhone"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your app will accept contactless payments using Tap to Pay on iPhone, you must complete additional setup:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"1-apply-for-the-tap-to-pay-on-iphone-entitlement","__idx":30},"children":["1. Apply for the Tap to Pay on iPhone Entitlement"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apple requires approval before you can use Tap to Pay. Submit a request through your Apple Developer account:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sign in to your Apple Developer account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certificates, Identifiers & Profiles"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identifiers"]}," and select your App ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Additional Capabilities"]},", request the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tap to Pay on iPhone"]}," entitlement"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete Apple's application form with your business details"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Wait for Apple's approval (typically 1–5 business days)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"2-configure-xcode-capabilities","__idx":31},"children":["2. Configure Xcode Capabilities"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once approved, enable the following in your Xcode project:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open your project in Xcode"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select your app target and go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Signing & Capabilities"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+ Capability"]}," and add:"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Near Field Communication Tag Reading"]}," (required for NFC access)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure your provisioning profile includes the Tap to Pay entitlement"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"3-update-infoplist","__idx":32},"children":["3. Update Info.plist"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the following keys to your Info.plist:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"xml","header":{"controls":{"copy":{}}},"source":"<key>NFCReaderUsageDescription</key>\n<string>This app uses NFC to accept contactless payments.</string>\n\n<key>NSLocationWhenInUseUsageDescription</key>\n<string>Location is required to verify payment acceptance eligibility.</string>\n","lang":"xml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"4-entitlements-file","__idx":33},"children":["4. Entitlements File"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ensure your app's entitlements file includes:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"xml","header":{"controls":{"copy":{}}},"source":"<key>com.apple.developer.proximity-reader.payment.acceptance</key>\n<true/>\n","lang":"xml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"testing","__idx":34},"children":["Testing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["[to be written]"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Include:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["How to use UAT"]},"* (including creating a Sandbox Apple ID)*"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["https://developer.apple.com/help/app-store-connect/test-in-app-purchases/create-a-sandbox-apple-account/"]},"* *"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Sample test cards / test values"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["How to simulate failures (e.g., declined cards)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["How to test Tap to Pay flows"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["How to switch environments easily"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"quick-start-checklist","__idx":35},"children":["Quick Start Checklist"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin integration, verify you have completed the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Created a merchant account in the Flute dashboard"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generated API credentials (Client ID and Client Secret)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stored credentials securely"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added the Flute Mobile SDK to your Xcode project"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set the SDK framework to \"Embed & Sign\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["(Tap to Pay only)"]}," Applied for and received Apple's Tap to Pay entitlement"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["(Tap to Pay only)"]}," Configured NFC capability in Xcode"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["(Tap to Pay only)"]}," Added required Info.plist keys"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"next-steps","__idx":36},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have completed the setup above, proceed to:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Installation & Setup"]}," – Add the SDK to your project"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Initialization"]}," – Create an SDK instance connected to your chosen environment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authenticate"]}," – Authenticate using your Client ID and Client Secret"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transactions"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tap to Pay"]}," – Begin processing payments or reading reports"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"installation--setup","__idx":37},"children":["Installation & Setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you get the Flute Mobile SDK Swift package, drag-and-drop it into Xcode to add it as a project dependency."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure that the Flute Mobile SDK is visible in the project navigator."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Once it is uploaded, select the option “Embed & Sign”."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods-specification--init-and-session-management","__idx":38},"children":["Methods Specification – Init and Session Management"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"init","__idx":39},"children":["Init"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates an instance of the Flute Mobile SDK connected to a specific environment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important: Main Thread Requirement"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To ensure Tap to Pay on iPhone functions correctly, the Flute Mobile SDK must be initialized on the app’s main thread. The underlying framework performs mandatory system integrity and security checks that are restricted to the main run loop. Attempting to initialize the SDK from a background thread will cause these checks to fail and result in initialization errors."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This can be achieved by initializing the SDK from the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["AppDelegate"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["SceneDelegate"]},", or by wrapping the call inside a ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["DispatchQueue.main.async"]}," block."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"init(environment: Environment) throws\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Target Flute environment (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".production"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".sandbox"]},"). See Get Started for environment details."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}," An error if the SDK fails to initialize."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"import AriseMobileSdk\n\ninit() {\n    let ariseSdk = try AriseMobileSdk(environment: .uat)\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["}"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"// Option 1: AppDelegate\nfunc application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {\n    // This runs on the main thread by default\n    let ariseSdk = try AriseMobileSdk(environment: .uat)\n    return true\n}\n\n// Option 2: SwiftUI\n@main\nstruct YourApp: App {\n    @StateObject private var ariseSdk = try! AriseMobileSdk(environment: .uat)\n\n    var body: some Scene {\n        WindowGroup {\n            ContentView()\n                .environmentObject(ariseSdk)\n        }\n    }\n}\n\n// Option 3: Explicitly wrapping in the Main Thread\n// Use this if you are initializing inside a background task or closure\nDispatchQueue.main.async {\n    let ariseSdk = try AriseMobileSdk(environment: .uat)\n}\n\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authenticate","__idx":40},"children":["Authenticate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start a new session used to authenticate to the Flute API and enable communication between the mobile client app and the Flute backend. Once the Access Token and Refresh Token are generated, they are stored in secure storage and reused on upcoming calls."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flute Mobile SDK automatically manages the authentication tokens, including refreshing it when it is about to expire."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use the Flute Mobile SDK methods, you will first need to provide the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientSecret"]}," parameters from your Merchant Account. Read Obtain Client Credentials for more information on how to retrieve these credentials."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func authenticate(clientId: String, clientSecret: String) async throws -> Bool\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clientId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The merchant account’s Client ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clientSecret"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The merchant account’s Client Secret"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bool: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if authentication succeeded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AuthenticationError"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["invalidCredentials - Your client ID or secret is incorrect"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["networkError - Network connection problem"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["invalidResponse - Server returned unexpected data"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let result = try await ariseSdk.authenticate(\n     clientId: \"your-client-id\",\n     clientSecret: \"your-client-secret\"\n)\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-access-token","__idx":41},"children":["Get Access Token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the current Access Token, which can be used to directly call the Flute API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Calling the Flute API directly is only recommended for calling endpoints related to features that are not yet available on the Flute Mobile SDK, such as Quick Payments, Invoices, etc."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getAccessToken() async -> String?\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String``?"]}," - The access token if valid and not expired, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}," otherwise"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"if let **token = **await** `arise`Sdk.getAccessToken() {\n\n    // Use token to call Flute API directly\n\n    print(\"Access token: \\(token)\")\n\n\n} else {\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["print(\"No valid access token available\")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["}"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refresh-access-token","__idx":42},"children":["Refresh Access Token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generate a new Access Token in case the current token is about to expire."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Access/Refresh Tokens are automatically managed by the Flute Mobile SDK in the background, so implementing a custom logic for refreshing the token is not required."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func refreshAccessToken() async throws -> Bool\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bool: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if token refresh succeeded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AuthenticationError"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["invalidCredentials - Your client ID or secret is incorrect"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["networkError - Network connection problem"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["invalidResponse - Server returned unexpected data"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let result = try await ariseSdk.refreshAccessToken()\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"clear-stored-token","__idx":43},"children":["Clear Stored Token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remove all stored authentication tokens. Useful to close the session (logout) with the Flute backend."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func clearStoredToken()\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nothing (void method)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"ariseSdk.clearStoredToken()\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods-specification--transactions","__idx":44},"children":["Methods Specification – Transactions"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-transactions-list","__idx":45},"children":["Get Transactions List"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves a paginated list of transactions of the merchant account. Optionally set filters to scope the response by pagination, date ranges, or batch identifiers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getTransactions(filters: TransactionFilters? = nil) async throws -> TransactionsResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TransactionFilters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property Name"},"children":["Property Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pageSize"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page size  - number of items per page. Must be between 1 and 100."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orderBy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field used to sort the transactions list. Case-insensitive. Options: - date [default] - totalAmount - status - customerPan - cardTokenType - id - paymentMethodType - operationMode - customerName - customerCompany - merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["asc"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the sort direction for the results. When true, results are sorted in ascending order. When false, results are sorted in descending order. true: ascending order false [default]: descending order"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["createdById"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CreatedById - Identifier of the specific entity that created the transaction (e.g.: terminal ID, invoice ID, quick payment ID, etc.)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["batchId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BatchId"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["noBatch"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If true – return only transactions that haven’t been settled yet (open batch)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TransactionsResponse - Result of getTransactions request containing a paged list with TransactionSummaries."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let filters = try TransactionFilters(\n    page: 0,\n    pageSize: 20,\n    orderBy: \"date\",\n    asc: false\n)\nlet result = try await ariseSdk.getTransactions(filters: filters)\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-transaction-details","__idx":46},"children":["Get Transaction Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get transaction receipt (detailed transaction information). Retrieves complete details for a specific transaction."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getTransactionDetails(id: String) async throws -> TransactionDetails\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property Name"},"children":["Property Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction unique identifier (UUID format)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TransactionDetails - describing the transaction, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}," when the transaction cannot be found."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Throws: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let transactionId = \"123e4567-e89b-12d3-a456-426614174000\"\nif let details = try await ariseSdk.getTransactionDetails(id: transactionId) {\n     print(\"Transaction ID: \\(details.transactionId ?? \"N/A\")\")\n     print(\"Amount: \\(details.amount?.totalAmount ?? 0)\")\n     print(\"Status: \\(details.status ?? \"N/A\")\")\n }\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submit-an-authorization-transaction-auth","__idx":47},"children":["Submit an Authorization Transaction (AUTH)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initiate a payment authorization, placing a temporary hold on the customer's funds without immediate capture. This hold is valid for 7 days. To complete the transaction, a \"Capture\" transaction must be submitted within this window; otherwise, the authorization expires and the funds hold is automatically released to the customer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PCI-DSS Responsibility Notice"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This method may process cardholder data depending on the integration method used. Sending raw card data through this API significantly increases PCI-DSS compliance requirements. Integrators are responsible for ensuring PCI-DSS compliance applicable to their implementation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func submitAuthTransaction(input: CardTransactionRequest) async throws -> AuthorizationResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardTransactionRequest"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization transaction input parameters"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Returns: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CardTransactionResponse containing authorization status, transaction ID, etc."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let input = try CardTransactionRequest(\n    paymentProcessorId: \"197c05e0-f99a-49bb-905c-d3da9d1e7200\",\n    amount: 123.45,\n    currency: .usd,\n    cardDataSource: .manual\n    accountNumber: \"4111111111111111\",\n    expirationMonth: 12,\n    expirationYear: 24,\n    securityCode: \"123\"\n)\n\n\nlet result = try await ariseSdk.submitAuthTransaction(input: input)\nprint(\"Transaction ID: \\(result.transactionId ?? \"N/A\")\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submit-a-sale-transaction-sale","__idx":48},"children":["Submit a Sale Transaction (SALE)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Executes a combined authorization and capture actions. This method immediately charges the customer’s card and marks the funds for settlement. Use this method for transactions where goods or services are delivered instantly."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PCI-DSS Responsibility Notice"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This method may process cardholder data depending on the integration method used. Sending raw card data through this API significantly increases PCI-DSS compliance requirements. Integrators are responsible for ensuring PCI-DSS compliance applicable to their implementation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func submitSaleTransaction (input: CardTransactionRequest) async throws -> AuthorizationResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardTransactionRequest"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization transaction input parameters"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Returns: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CardTransactionResponse containing authorization status, transaction ID, etc."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Throws: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let input = try CardTransactionRequest (\n    paymentProcessorId: \"197c05e0-f99a-49bb-905c-d3da9d1e7200\",\n    amount: 123.45,\n    currency: .usd,\n    cardDataSource: .manual\n    accountNumber: \"4111111111111111\",\n    expirationMonth: 12,\n    expirationYear: 24,\n    securityCode: \"123\"\n)\n\n\nlet result = try await ariseSdk.submitSaleTransaction(input: input)\nprint(\"Transaction ID: \\(result.transactionId ?? \"N/A\")\")\n\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"void-a-transaction-void","__idx":49},"children":["Void a Transaction (VOID)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cancels a transaction before it has been settled. Use this to cancel an Authorization or Sale transaction. Voiding a transaction prevents any charges from the customer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: Voids are only possible for unsettled transactions. If the transaction has already been processed in your daily batch, you must use the Refund method instead."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func voidTransaction (transactionId: String) async throws -> TransactionResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["VoidTransactionRequest - Input parameters for voiding a transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction unique identifier (UUID format) to void"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TransactionResponse - containing updated transaction details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Throws: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let transactionId = \"123e4567-e89b-12d3-a456-426614174000\"\ndo {\n    let result = try await ariseSdk.voidTransaction(transactionId: transactionId)\n    print(\"Transaction voided successfully\")\n    print(\"New status: \\(result.status ?? \"N/A\")\")\n    print(\"Response: \\(result.responseDescription ?? \"N/A\")\")\n} catch AriseApiError.apiError(let message) {\n    print(\"Cannot void transaction: \\(message)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"capture-a-transaction-capture","__idx":50},"children":["Capture a Transaction (CAPTURE)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Completes a previously authorized payment. This method converts the \"hold\" created by an Authorization (AUTH) transaction into an actual charge. You can capture the full authorized amount or a partial amount. Once successful, the funds are marked for settlement and will be transferred to the merchant account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: Captures must typically be performed within 7 days of the initial authorization; otherwise, the authorization expires."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func captureTransactionRequest (transactionId: String, amount: Double\n) async throws -> TransactionResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the authorization transaction to capture"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount to capture If the amount is lower than the authorized amount, the difference will be released, and the customer will be charged only the captured amount."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TransactionResponse - containing updated transaction details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Throws: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n   let result = try await ariseSdk.captureTransaction(\n    transactionId: transactionId,\n    amount: amountToCapture)\n    print(\"Transaction voided successfully\")\n    print(\"New status: \\(result.status ?? \"N/A\")\")\n    print(\"Response: \\(result.responseDescription ?? \"N/A\")\")\n} catch AriseApiError.apiError(let message) {\n    print(\"Cannot void transaction: \\(message)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refund-a-transaction-refund","__idx":51},"children":["Refund a Transaction (REFUND)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns funds to a customer for a transaction that has already been settled. This method initiates a reversal of the payment flow, moving money from the merchant account back to the customer’s card."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: Unlike a void, a refund can be issued days or weeks after the original sale. You can perform a Full Refund of the entire amount or a Partial Refund."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func refundTransaction (transactionId: String, amount: Double\n) async throws -> TransactionResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the authorization transaction to capture"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount to capture If the amount is lower than the authorized amount, the difference will be released, and the customer will be charged only the captured amount."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Returns: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TransactionResponse containing authorization status, transaction ID, authorization code, transaction receipt, and other transaction details.."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"Code Example:\n let partialResult = try await ariseSdk.refundTransaction(\ntransactionId: transactionId,\namount: 25.00)\n\n\nprint(\"Partial refund approved:\n\\(partialResult.transactionReceipt?.amount?.totalAmount ?? 0)\")\n\n// Full remaining refund\nlet fullResult = try await ariseSdk.refundTransaction(\n RefundRequest(\n transactionId: transactionId,\n cardDataSource: .manual))\n\nprint(\"Remaining amount refunded. New status:\n\\(fullResult.status ?? \"N/A\")\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"calculate-amount","__idx":52},"children":["Calculate Amount"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Calculates the final transaction amount based on the merchant settings. This method is useful for merchant accounts that have ZCP (Zero Cost Processing) such as Dual Pricing, Cash Discount or Credit Card Surcharge enabled."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By providing the base amount of the transaction, the method calculates the final amount for each payment method, allowing the customer to acknowledge the final amounts and choose the preferred payment method to use."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func calculateAmount(request: CalculateAmountRequest) async throws -> CalculateAmountResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property Name"},"children":["Property Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CalculateAmountRequest"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount calculation inputs such as base amount, percentage-off, surcharge, tips, and currency."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["CalculateAmountResponse  containing currency metadata and per-tender breakdown (credit card, debit card, ACH and cash)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["**Throws: **"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let calculation = try await ariseSdk.calculateAmount(\nrequest: CalculateAmountRequest(\namount: 100.0,\ncurrency: .usd\npercentageOffRate: 5.0,\nsurchargeRate: 3.0,\ntipAmount: 10.0,\nuseCardPrice: true\n)\n)\nprint(\"Card total: \\(calculation.creditCard?.totalAmount ?? 0)\")\nprint(\"Cash total: \\(calculation.cash?.totalAmount ?? 0)\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods-specification---tap-to-pay","__idx":53},"children":["Methods Specification - Tap to Pay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay requires iPhone XS or later running iOS 18+. See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get Started"]}," for requirements and entitlement setup."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"check-compatibility","__idx":54},"children":["Check Compatibility"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Checks whether the current device can use Tap to Pay on iPhone feature."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func checkCompatibility() -> TTPCompatibilityResult\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPCompatibilityResult containing detailed compatibility information."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompatible"]}," property is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," when all prerequisites are met."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let result = ariseSdk.ttp.checkCompatibility()\nif result.isCompatible {\nprint(\"Device is compatible with Tap to Pay\")\nprint(\"Device: \\(result.deviceModelCheck.modelIdentifier)\")\nprint(\"iOS Version: \\(result.iosVersionCheck.version)\")\n} else {\nprint(\"Device is not compatible:\")\nfor reason in result.incompatibilityReasons {\nprint(\"- \\(reason)\")\n}\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-status","__idx":55},"children":["Get Status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves the Tap to Pay activation status for the current device."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getStatus() async throws -> TTPStatus\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\nlet status = try await ariseSdk.ttp.getStatus()\nif status == .active {\nprint(\"Tap to Pay is active\")\n} else {\nprint(\"Tap to Pay is inactive - guide user through activation\")\n}\n} catch AriseApiError.apiError(let message) {\nprint(\"Failed to get status: \\(message)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPStatus Tap to Pay activation status for a device"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError when the API returns an error or the response cannot be decoded."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"activate","__idx":56},"children":["Activate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Activates Tap to Pay on the current device. This method initiates Apple's Tap to Pay activation workflow (by showing the Apple’s Terms & Conditions to use Tap To Pay on iPhone) and then updates the device’s Tap To Pay status to Active."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: Ensure this method is only called if the phone user is an actual business administrator of the merchant account or has been authorized by a business administrator to enable Tap To Pay on iPhone."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method Signature"]}," func** activate() ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["async"]}," throws** Parameters:**"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay status is not active (returns specific error)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay is not initialized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay configuration fails"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n          try await ariseSdk.ttp. activate()\n} catch let error as TTPError {\n    print(\"❌ Activation failed: \\(error.localizedDescription)\")\n} catch let error as AriseApiError {\n    print(\"❌ API error: \\(error.localizedDescription)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"show-educational-information","__idx":57},"children":["Show Educational Information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shows educational information about Tap to Pay. This method presents an SDK-provided educational screen/modal with content generated by Apple. The educational content helps merchants understand setup, best practices, and device handling before accepting payments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method Signature"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func showEducationalInfo(viewController: UIViewController) async throws\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["viewController"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UIViewController"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The view controller from which to present the educational content."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError when the API returns an error or the response cannot be decoded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay status is not active (returns specific error)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay SDK is not initialized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay SDK configuration fails"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n          try await ariseSdk.ttp.showEducationalInfo(from: self)\n          print(\"Educational content was shown and dismissed\")\n       } catch let error as TTPError {\n          print(\"Failed to show educational content: \\(error.localizedDescription)\")\n       }\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"prepare-the-card-reader","__idx":58},"children":["Prepare the Card Reader"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Prepares Tap to Pay by initializing the Proximity Reader and configuring the SDK with merchant information."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This method warms up the device and initializes the Proximity Reader so that Tap to Pay operations can start faster when needed. The initialization happens in the background without presenting any UI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When to call this method:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Recommended: Call once at application startup (e.g., after user login) to prepare the reader"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After activate() has been called successfully (Tap to Pay must be active)"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Important: You do NOT need to call this method before every transaction. The SDK handles reader initialization and token refresh internally during transaction operations. This method is for one-time setup at application startup to optimize performance."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Important: This method does NOT activate Tap to Pay. If Tap to Pay is not active, this method will throw TTPError.notActive. To activate Tap to Pay, first you need to call activate()."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func prepare() async throws\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay status is not active (returns specific error)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SDK is not initialized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SDK configuration fails"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\ntry await ariseSdk.ttp.prepare()\nprint(\"Tap to Pay is ready\")\n} catch let error as TTPError {\nprint(\"Failed to prepare: \\(error.localizedDescription)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"perform-a-tap-to-pay-transaction","__idx":59},"children":["Perform a Tap To Pay Transaction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method Signature"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"public func performTransaction(amount:)(amount: Decimal) async throws  -> TTPTransactionResult\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Performs a Tap to Pay transaction by passing the total amount. Once called, this method brings up Apple's Tap to Pay screen for the customer to present the card."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before calling this method, ensure that the proximity reader has been initiated by calling the prepare() method."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note: This method is recommended for merchants that don’t have the Zero Cost Processing (ZCP) mode “Credit Card Surcharge” enabled. If the merchant has the Credit Card Surcharge enabled, this method will throw an error indicating to use the alternate performTransaction method with additional parameters."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Decimal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction amount as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Decimal"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns: TTPTransactionResult"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay status is not active (returns specific error)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay is not initialized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay configuration fails"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentCardReaderError"]}," if the card reader encounters an error"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if API calls fail (network errors, authentication errors, etc.)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do** {\n**let** result = **try** await** ariseSdk.ttp.performTransaction(amount: Decimal(100.0))\nprint(\"Transaction ID: \\(result.transactionId ?? \"N/A\")\")\nprint(\"Status: \\(result.status)\")\n} **catch** let** error **as** TTPError {\nprint(\"❌ Transaction failed: \\(error.localizedDescription)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"tap-to-pay-transaction-with-credit-card-surcharge","__idx":60},"children":["Tap To Pay Transaction with Credit Card Surcharge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Performs a Tap to Pay transaction with extended amount calculation information. Once called, this method brings up Apple's Tap to Pay screen for the customer to present the card."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This method must be used for card payments when the merchant account has enabled the Zero Cost Processing mode “Credit Card Surcharge”. It uses a pre-calculated amount result from method ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["calculateAmount()"]}," and allows specifying whether customer card is a debit card or credit card. The surcharge is only applied if the card is a credit card."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method Signature"]}," func** performTransaction(calculationResult:isDebitCard:) ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["async"]}," throws** ->** TTPTransactionResult"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["calculationResult"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CalculateAmountResponse"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["calculateAmount()"]}," method containing amount breakdowns for different payment types."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isDebitCard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["true: debit card (surcharge will not be applied) false: credit card (surcharge will be applied to the final amount)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TTPTransactionResult"]}," containing normalized transaction data suitable for subsequent API posting."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay status is not active (returns specific error)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay is not initialized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay configuration fails"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentCardReaderError"]}," if the card reader encounters an error"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if API calls fail (network errors, authentication errors, etc.)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do** {\n**let** calculation = **try** await** ariseSdk.calculateAmount(\nrequest: CalculateAmountRequest(amount: 100.0)\n)\n**let** result = **try** await** ariseSdk.ttp.performTransaction(\ncalculationResult: calculation,\nisDebitCard: **false**\n)\nprint(\"Transaction ID: \\(result.transactionId ?? \"N/A\")\")\nprint(\"Status: \\(result.status)\")\n} **catch** let** error **as** TTPError {\nprint(\"❌ Transaction failed: \\(error.localizedDescription)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"abort-transaction","__idx":61},"children":["Abort Transaction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This method cancels the transaction while the “present card” screen is visible."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"Method Signature:\n func abortTransaction() async throws -> Bool\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if the transaction was successfully aborted."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".sdkNotInitialized: SDK is not initialized"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[".failedToAbortTransaction Transaction cannot be aborted because card reading has begun,"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do** {\n     **let** aborted = **try await** ariseSdk.ttp.abortTransaction()\n     **if** aborted {\n         print(\"Transaction was successfully aborted\")\n         // UI is automatically dismissed\n     } **else** {\n         print(\"No active transaction to abort\")\n     }\n } **catch** {\n     print(\"Error: \\(error.localizedDescription)\")\n }\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"events-stream","__idx":62},"children":["Events Stream"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provides a real-time stream of events from Tap to Pay operations. This method returns an asynchronous stream that delivers events as they occur during. Tap to Pay transactions and operations. Use this to monitor transaction progress, card reader state changes, and receive real-time updates for your UI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Method Signature"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["func"]}," eventsStream() ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["throws"]}," -> AsyncStream<TTPEvent>"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Return Value"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns **AsyncStream<",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TTPEvent>"]},":"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["TTPError if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay status is not active (returns specific error)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay is not initialized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tap to Pay configuration fails"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"do {\n         for await event in try ariseSdk.ttp.eventsStream() {\n             switch event {\n             case .readerEvent(let readerEvent):\n                 switch readerEvent {\n                 case .updateProgress(let progress):\n                     print(\"Reader progress: \\(progress)%\")\n                 case .cardDetected:\n                     print(\"Card detected\")\n                 case .readCompleted:\n                     print(\"Card read completed\")\n                 default:\n                     print(\"Reader event: \\(readerEvent)\")\n                 }\n             case .customEvent(let customEvent):\n                 switch customEvent {\n                 case .preparing:\n                     print(\"Preparing terminal...\")\n                 case .ready:\n                     print(\"Terminal is ready\")\n                 case .approved:\n                     print(\"Transaction approved!\")\n                 case .declined:\n                     print(\"Transaction declined\")\n                 case .readerNotReady(let reason):\n                     print(\"Reader not ready: \\(reason)\")\n                 default:\n                     print(\"Custom event: \\(customEvent)\")\n                 }\n             }\n         }\n     } catch TTPError.sdkNotInitialized {\n         print(\"SDK is not initialized\")\n     }\n\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods-specification---settings","__idx":63},"children":["Methods Specification - Settings"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-payment-settings","__idx":64},"children":["Get Payment Settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves payment configuration settings for the merchant account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getPaymentSettings() async throws -> PaymentSettingsResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["PaymentSettingsResponse containing normalized configuration data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request or the response cannot be decoded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let settings = try await ariseSdk.getPaymentSettings()\nprint(\"Available currencies: \\(settings.availableCurrencies.map {\n    $0.name ?? \"\" })\")\nprint(\"ZCP mode: \\(settings.zeroCostProcessingOption ?? \"None\")\")\nprint(\"Tips enabled: \\(settings.isTipsEnabled)\")\nprint(\"Default surcharge rate: \\(settings.defaultSurchargeRate ?? 0)%\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-permissions","__idx":65},"children":["Get Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the list of enabled API permissions for the currently authenticated user."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getPermissions() async throws -> ApiPermissionsResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ApiPermissionsResponse containing list of enabled API permissions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError if the Flute API rejects the request or the response cannot be decoded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let permissions = try await ariseSdk.getPermissions()\nprint(\"Enabled permissions: \\(permissions.permissions)\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods-specification--device-management","__idx":66},"children":["Methods Specification – Device Management"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-devices","__idx":67},"children":["Get Devices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves smartphone devices linked to the merchant account, along with device information and the status for the Tap To Pay functionality for each device."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getDevices() async throws -> DevicesResponse\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DevicesResponse containing device metadata straight from the merchant devices API (identifier, device name, Tap to Pay status text/id, last login timestamp, associated profiles)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError when the API returns an error or the response cannot be decoded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let devices = try await ariseSdk.getDevices()\ndevices.devices.forEach { device in\n    print(\"\\(device.deviceName) -> \\(device.tapToPayStatus ?? \"Unknown\")\")\n}\n\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-device-info","__idx":68},"children":["Get Device Info"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves detailed information for a specific device by its identifier."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method signature:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"func getDeviceInfo(deviceId: String) async throws -> DeviceInfo\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deviceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique device identifier"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DeviceInfo containing device details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Throws:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AriseApiError when the API returns an error or the response cannot be decoded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let deviceId = \"123e4567-e89b-12d3-a456-426614174000\"\ndo {\nlet deviceInfo = try await ariseSdk.getDeviceInfo(deviceId: deviceId)\nprint(\"Device: \\(deviceInfo.deviceName ?? \"Unknown\")\")\nprint(\"TTP Status: \\(deviceInfo.tapToPayStatus ?? \"Unknown\")\")\nprint(\"TTP Enabled: \\(deviceInfo.tapToPayEnabled)\")\nprint(\"Last Login: \\(deviceInfo.lastLoginAt?.description ?? \"Never\")\")\n} catch AriseApiError.apiError(let message) {\nprint(\"Error retrieving device: \\(message)\")\n}\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-device-id","__idx":69},"children":["Get Device ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the persistent device identifier stored in Keychain."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Method Signature"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":" func getDeviceId() -> String\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["String - A UUID string in lowercase format (e.g., \"123e4567-e89b-12d3-a456-426614174000\")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let deviceId = ariseSdk.getDeviceId()\nprint(\"Device ID: \\(deviceId)\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods-specification--general-information","__idx":70},"children":["Methods Specification – General Information"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-sdk-version","__idx":71},"children":["Get SDK Version"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the version of the Flute Mobile SDK for iOS that is embedded in your application."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Method Signature"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":" func getVersion() -> String\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["String - The version of the Flute Mobile SDK framework (e.g., “1.0.0”)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Code example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"swift","header":{"controls":{"copy":{}}},"source":"let version = ariseSdk.getVersion()\nprint(\"Flute Mobile SDK version: \\(version)\")\n","lang":"swift"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-models","__idx":72},"children":["API Models"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"transactions","__idx":73},"children":["Transactions"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionfilters","__idx":74},"children":["TransactionFilters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property Name"},"children":["Property Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pageSize"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page size"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["asc"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If true - sort by ascending.  If false - sort by descending"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orderBy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field to order by"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["createMethodId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CreateMethodId?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CreateMethodId"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["createdById"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CreatedById"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["batchId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["BatchId"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["noBatch"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If true - filter not settled transactions"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"createmethodid","__idx":75},"children":["CreateMethodId"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transaction creation method identifier"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enum Values"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Display Name"},"children":["Display Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["portal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Portal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Portal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["apiToken"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API Token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API Token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["terminal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["invoice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["quickPayment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quick Payment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quick Payment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["webComponent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Web Component"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Web Component"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscription"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["mobileApp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mobile App"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mobile App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tapToPay"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["9"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"currency","__idx":76},"children":["Currency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Currency type used for transaction amounts."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["usd"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["United States Dollar"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"zerocostprocessingoption","__idx":77},"children":["ZeroCostProcessingOption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Zero cost processing option for merchant payment settings. Determines how surcharges or discounts are applied to transactions."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["noZeroCost"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No zero cost processing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cashDiscount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cash discount pricing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["dualPricing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dual pricing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surcharge"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"operationtype","__idx":78},"children":["OperationType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Operation type for transaction operations. Represents the type of operation performed on a transaction."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorization"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization - reserves funds but does not capture"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sale"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sale - immediate payment with capture"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["capture"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Capture - captures previously authorized funds"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["void"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Void - cancels a transaction before settlement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["refund"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refund - returns funds after settlement"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"paymentmethodtype","__idx":79},"children":["PaymentMethodType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Payment method type for transactions. Represents the type of payment method used for a transaction."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["card"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card payment (credit or debit)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["electronicCheck"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Electronic check (ACH) payment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cash"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cash payment"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"accounttype","__idx":80},"children":["AccountType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Account type for ACH transactions. Represents the type of bank account used for ACH payments."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["checking"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Checking account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["savings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Savings account"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"accountholdertype","__idx":81},"children":["AccountHolderType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Account holder type for ACH transactions. Represents whether the account belongs to a person or a business."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["business"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["personal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Personal account"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactiontype","__idx":82},"children":["TransactionType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Transaction type. Represents the type of transaction operation."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorization"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Authorization”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization - reserves funds but does not capture"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sale"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Sale”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sale - immediate payment with capture"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["capture"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Capture”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Capture - captures previously authorized funds"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["void"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Void”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Void - cancels a transaction before settlement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["refund"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Refund”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refund - returns funds after settlement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardAuthentication"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“CardAuthentication”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card authentication transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["refundWORef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“RefundWORef”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refund without reference transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipAdjustment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“TipAdjustment”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip adjustment transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achDebit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“AchDebit”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH debit transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achRefund"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“AchRefund”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH refund transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achHold"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“AchHold”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH hold transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achUnHold"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“AchUnHold”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH unhold transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achCancel"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“AchCancel”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH cancel transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achCredit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“AchCredit”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH credit transaction"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionstatus","__idx":83},"children":["TransactionStatus"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description:"]}," Transaction status. Represents the aggregated status of a transaction."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Raw Value"},"children":["Raw Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Authorized”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funds reserved but not captured"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["captured"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Captured”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funds have been captured"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["voided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Voided”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancelled before settlement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["refunded"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Refunded”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funds returned after settlement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["verified"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Verified”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card verification completed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["settled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Settled”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Funds transferred"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partiallyAuthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“PartiallyAuthorized”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partially authorized"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["informational"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Informational”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Informational transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["scheduled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Scheduled”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction is scheduled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cancelled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Cancelled”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction is cancelled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["chargedBack"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“ChargedBack”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction has been charged back"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["inProgress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“InProgress”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction is in progress"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cleared"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Cleared”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction is cleared"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["held"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“Held”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction is held"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["heldByProcessor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["“HeldByProcessor”"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH transaction is held by processor"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionsresponse","__idx":84},"children":["TransactionsResponse"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array<TransactionSummary>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["total"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pagination metadata - total count of items"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionsummary","__idx":85},"children":["TransactionSummary"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Summary information about a transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction unique identifier (UUID format)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentProcessorId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processor unique identifier (UUID format)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction date and time (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["baseAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base amount of the transaction before surcharges, tips, taxes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["totalAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total amount of the transaction including all fees"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge amount applied to the transaction (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargePercentage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge percentage applied to the transaction (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currencyCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency code (e.g., USD, EUR) (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for the transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant name (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant unique identifier (UUID format, required)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationMode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation mode of the transaction (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentMethodType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PaymentMethodType ?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment method type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer name (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerCompany"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer company name (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerPan"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer Primary Account Number (masked card number) (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardTokenType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardTokenType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card token type enum - Local (1) or Network (2) (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerEmail"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer email address (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerPhone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer phone number (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionStatus?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction status (e.g., approved, declined)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type name (e.g., Authorization, Sale, Capture) (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["batchId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch identifier for settlement (UUID format, nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["source"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SourceResponseDto"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source information of the transaction (required)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableOperations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array<AvailableOperation>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of available operations that can be performed on this transaction (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AmountDto"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detailed amount breakdown including all fees, discounts, and taxes (required)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardtokentype","__idx":86},"children":["CardTokenType"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card token type enumeration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["local"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Local token type (value: 1) - Regular local tokenization"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Network token type (value: 2) - Network tokenization"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sourceresponsedto","__idx":87},"children":["SourceResponseDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Source information for the transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source unique identifier (UUID format, nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source name (required)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"availableoperation","__idx":88},"children":["AvailableOperation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available operation that can be performed on a transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available amount for this operation (nullable)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["suggestedTips"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array<SuggestedTipsDto>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of suggested tip amounts and percentages (nullable)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"suggestedtipsdto","__idx":89},"children":["SuggestedTipsDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Suggested tip information"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipPercent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip percentage"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip amount in currency"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"amountdto","__idx":90},"children":["AmountDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Detailed amount breakdown for the transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["baseAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base amount before any adjustments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["percentageOffAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount discounted by percentage off"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["percentageOffRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Percentage off rate applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cashDiscountAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cash discount amount applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cashDiscountRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cash discount rate applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge amount applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge rate applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip amount applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip rate applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["taxAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tax amount applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["taxRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tax rate applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["totalAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total amount after all adjustments, fees, and taxes"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactiondetails","__idx":91},"children":["TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique transaction identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionDateTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the transaction occurred. Format: ISO 8601 date-time"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orderNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional order identifier provided by the merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionAmountDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Complete amount information including base amount, surcharges, tips, discounts, and total amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for the transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["processorId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processor identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["processor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processor name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationTypeId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation type identifier. Numeric identifier for the operation type (e.g., Sale, Auth, Capture, Void, Refund)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation type name. Human-readable operation type name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type (e.g., sale, auth)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentMethodType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PaymentMethodType ?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment method type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer identifier. Unique identifier for the customer in the merchant’s system"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerPan"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer PAN (Primary Account Number). Masked card number or account number for security compliance"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardTokenType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardTokenType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card token type. Indicates whether the card is stored locally or on the network"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionStatus?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction status (e.g., approved, declined)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantAddress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantPhoneNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant phone number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantEmailAddress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant email address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantWebsite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant website"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization code. Authorization code returned by the payment processor. Only present for approved transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["source"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SourceResponseDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction source information. Information about the source of the transaction (e.g., POS terminal, online, mobile)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["responseCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response code. Response code from the payment processor indicating transaction result"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["responseDescription"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response description. Human-readable description of the transaction response"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardholderAuthenticationMethodId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardholderAuthenticationMethod?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cardholder authentication method identifier. Numeric identifier for the cardholder authentication method used"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardholderAuthenticationMethod"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cardholder authentication method name. Human-readable cardholder authentication method name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cvmResultMsg"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVM (Cardholder Verification Method) result message. Result message from cardholder verification"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardDataSourceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardDataSource?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card data source identifier. Numeric identifier for the card data source (e.g., Swipe, Chip, Contactless)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardDataSource"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card data source name. Human-readable card data source name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardProcessingDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardDetailsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card processing details. Detailed information about card processing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achProcessingDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ElectronicCheckDetails?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH (Electronic Check) processing details. Detailed information about ACH/electronic check processing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableOperations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available operations for this transaction. List of operations that can be performed on this transaction (e.g., Void, Refund, Capture)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["avsResponse"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AvsResponseDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AVS (Address Verification System) response. Response from address verification system"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["emvTags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EmvTagsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMV tags information. EMV (Europay, Mastercard, Visa) tag data from chip card transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tsysCardDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TsysCardDetailsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TSYS card details. Additional card details specific to TSYS processor"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AchDetailsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH details. Additional ACH transaction details"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionamountdto","__idx":92},"children":["TransactionAmountDto"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["baseAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base transaction amount before any fees, surcharges, or tips. This is the original transaction amount entered by the merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["percentageOffAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Percentage off amount. Discount amount calculated from percentage off rate"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["percentageOffRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Percentage off rate. Discount rate as decimal (e.g., 0.10 for 10%)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cashDiscountAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cash discount amount. Discount amount for cash payments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cashDiscountRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cash discount rate. Discount rate for cash payments as decimal (e.g., 0.05 for 5%)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge amount added to the base amount. Additional fee charged to the customer, typically calculated from surcharge rate"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge rate. Surcharge rate as decimal (e.g., 0.03 for 3%)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip amount. Gratuity amount added by the customer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip rate. Tip rate as decimal (e.g., 0.15 for 15%)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["totalAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total transaction amount. Final amount including base amount, surcharges, tips, and discounts. This is the amount that will be charged to the customer"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"carddetailsdto---transactiondetails","__idx":93},"children":["CardDetailsDto - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary<String, Any>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw card details data."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"electroniccheckdetails----transactiondetails","__idx":94},"children":["ElectronicCheckDetails  - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary<String, Any>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw ACH details data. Placeholder for ACH details until full structure is defined"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"avsresponsedto---transactiondetails","__idx":95},"children":["AvsResponseDto - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary<String, Any>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw AVS response data. Placeholder for AVS response until full structure is defined. Response from address verification system used to verify cardholder billing address"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"emvtagsdto---transactiondetails","__idx":96},"children":["EmvTagsDto - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary<String, Any>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw EMV tags data. Placeholder for EMV tags until full structure is defined. EMV (Europay, Mastercard, Visa) tag data from chip card transactions"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"tsyscarddetailsdto","__idx":97},"children":["TsysCardDetailsDto"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary<String, Any>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw TSYS card details data. Placeholder for TSYS card details until full structure is defined. Additional card details specific to TSYS processor"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"achdetailsdto","__idx":98},"children":["AchDetailsDto"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerAccountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number for ACH transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerRoutingNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Routing number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountHolderType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AccountHolderType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account holder type (Personal/Business)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AccountType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account type (Checking/Savings)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["taxId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tax identifier"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardtokentype---transactiondetails","__idx":99},"children":["CardTokenType - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["local"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card stored locally in merchant’s system. Raw value: 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card stored on payment network (tokenized). Raw value: 2"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardholderauthenticationmethod---transactiondetails","__idx":100},"children":["CardholderAuthenticationMethod - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["rawValue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cardholder authentication method with raw integer value (0-8). Represents the method used to authenticate the cardholder during transaction"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"carddatasource---transactiondetails","__idx":101},"children":["CardDataSource - TransactionDetails"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["rawValue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card data source with raw integer value (1-7). Represents the source of card data (e.g., Swipe, Chip, Contactless)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardtransactionrequest","__idx":102},"children":["CardTransactionRequest"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Input parameters for submitting an authorization transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentProcessorId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processor identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for the transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardDataSource"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardDataSource"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card data source"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentMethodId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer payment method ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["accountNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account number (card number)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["expirationMonth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expiration month"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["expirationYear"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expiration year"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["securityCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Security code (CVV/CVC)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["track1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Track 1 data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["track2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Track 2 data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["emvTags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMV tags"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["emvPaymentAppVersion"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMV payment application version"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip rate"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["percentageOffRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Percentage off rate"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge rate"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["useCardPrice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use card price flag"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["billingAddress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AddressDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Billing address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shippingAddress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AddressDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Shipping address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["contactInfo"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ContactInfoDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact information"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PIN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pinKsn"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PIN KSN (Key Serial Number)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["emvFallbackCondition"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMVFallbackCondition?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMV fallback condition"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["emvFallbackLastChipRead"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMVFallbackLastChipRead?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMV fallback last chip read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["referenceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerInitiatedTransaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer initiated transaction flag"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardtransactionresponse","__idx":103},"children":["CardTransactionResponse"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Result of authorization transaction submission"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique transaction identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionDateTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time of transaction execution"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionStatus?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction status (e.g., approved, declined)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["processedAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Processed amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionResponseDetailsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction response details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionReceipt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionReceiptDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction receipt"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["avsResponse"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AvsResponseDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AVS (Address Verification System) response"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"carddatasource---authrequest","__idx":104},"children":["CardDataSource - AuthRequest"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["rawValue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"addressdto","__idx":105},"children":["AddressDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Address information structure"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["line1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address line 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["line2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address line 2"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["city"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["postalCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal code (ZIP code)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["stateName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["stateId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["countryId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country identifier"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"contactinfodto","__idx":106},"children":["ContactInfoDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Contact information"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["firstName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lastName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["companyName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Company name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["mobileNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mobile phone number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["smsNotification"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS notification enabled"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"emvfallbackcondition","__idx":107},"children":["EMVFallbackCondition"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EMV fallback condition enumeration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["iccTerminalError"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ICC Terminal Error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["noCandidateList"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No Candidate List"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"emvfallbacklastchipread","__idx":108},"children":["EMVFallbackLastChipRead"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EMV fallback last chip read enumeration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["successful"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Successful"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Failed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["notAChipTransaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not A Chip Transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unknown"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unknown"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionresponsedetailsdto","__idx":109},"children":["TransactionResponseDetailsDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transaction response details"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostResponseCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Host response code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostResponseMessage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Host response message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostResponseDefinition"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Host response definition"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["High-level operation response code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["message"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["processorResponseCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Processor response code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["maskedPan"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Masked PAN (Primary Account Number)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionreceiptdto","__idx":110},"children":["TransactionReceiptDto"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transaction receipt information"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique transaction identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionDateTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the transaction occurred"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orderNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant order number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionAmountDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Complete amount information including base amount, surcharges, tips, discounts, and total amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for the transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["processorId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processor identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["processor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment processor name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationTypeId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation type identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation type name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type (e.g., sale, auth)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paymentMethodType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PaymentMethodType ?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment method type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customerPan"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer PAN (Primary Account Number)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardTokenType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardTokenType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card token type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionStatus?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction status (e.g., approved, declined)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantAddress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantPhoneNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant phone number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantEmailAddress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant email address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["merchantWebsite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant website"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["source"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SourceResponseDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction source information"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["responseCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["responseDescription"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response description"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardholderAuthenticationMethodId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardholderAuthenticationMethod?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cardholder authentication method identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardholderAuthenticationMethod"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cardholder authentication method name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cvmResultMsg"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVM (Cardholder Verification Method) result message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardDataSourceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardDataSource?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card data source identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardDataSource"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card data source name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardProcessingDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CardDetailsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card processing details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achProcessingDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ElectronicCheckDetails?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH (Electronic Check) processing details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableOperations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[TransactionOperation]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available operations for this transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["avsResponse"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AvsResponseDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AVS (Address Verification System) response"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["emvTags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EmvTagsDto?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EMV tags information"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardtokentype---receipt","__idx":111},"children":["CardTokenType - Receipt"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["local"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card stored locally in merchant's system"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card stored on payment network (tokenized)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"cardholderauthenticationmethod---receipt","__idx":112},"children":["CardholderAuthenticationMethod - Receipt"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["rawValue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"carddetailsdto---receipt","__idx":113},"children":["CardDetailsDto - Receipt"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card details for a transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String: Any]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw card details data"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"electroniccheckdetails---receipt","__idx":114},"children":["ElectronicCheckDetails - Receipt"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Electronic check (ACH) details"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String: Any]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw ACH details data"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionoperation","__idx":115},"children":["TransactionOperation"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"propertyName"},"children":["propertyName"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available amount for this operation. Maximum amount that can be processed for this operation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["suggestedTips"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array< SuggestedTipsDto>?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Suggested tip amounts. List of suggested tip amounts and percentages"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"avsresponsedto---authresult-receipt","__idx":116},"children":["AvsResponseDto - AuthResult-Receipt"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AVS (Address Verification System) response"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String: Any]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw AVS response data"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"emvtagsdto---receipt","__idx":117},"children":["EmvTagsDto - Receipt"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EMV tags information"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String: Any]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Raw EMV tags data"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transactionresponse","__idx":118},"children":["TransactionResponse"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique transaction identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionDateTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the transaction was performed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TransactionStatus?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction status (e.g., approved, declined)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"refundrequest","__idx":119},"children":["RefundRequest"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"calculateamountrequest","__idx":120},"children":["CalculateAmountRequest"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base transaction amount before any discounts or surcharges."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["percentageOffRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Percentage-off or discount rate (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5.0"]}," for a 5% discount)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge rate to apply (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["3.0"]}," for a 3% surcharge)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absolute tip amount to add on top of the base amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tipRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip rate expressed as percentage (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10.0"]}," for a 10% gratuity)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for the transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["useCardPrice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the provided ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," represents the card price (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},") or cash price (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},") in Dual Pricing mode."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"calculateamountresponse","__idx":121},"children":["CalculateAmountResponse"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property Name"},"children":["Property Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for the transaction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable currency code (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USD"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["zeroCostProcessingOption"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ZeroCostProcessingOption (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Active Zero Cost Processing option"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["useCardPrice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether card pricing was applied during calculation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cash"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AmountDto"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Breakdown for cash payments, if available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["creditCard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AmountDto"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Breakdown for credit card payments, if available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["debitCard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AmountDto"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Breakdown for debit card payments, if available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ach"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AmountDto"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Breakdown for ACH payments, if available."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"settings","__idx":122},"children":["Settings"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"paymentsettingsresponse","__idx":123},"children":["PaymentSettingsResponse"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment configuration settings for the merchant organization."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableCurrencies"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[NamedOption]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available currencies for transactions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["zeroCostProcessingOption"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ZeroCostProcessingOption?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Active Zero Cost Processing option"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["defaultSurchargeRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default surcharge rate (as a percentage)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["defaultCashDiscountRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default cash discount rate (as a percentage)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["defaultDualPricingRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default dual pricing rate (as a percentage)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isTipsEnabled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether tips are enabled for transactions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["defaultTipsOptions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[Double]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default tip options (as percentages)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableCardTypes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[NamedOption]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available card types supported by the merchant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availableTransactionTypes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[NamedOption]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available transaction types supported by the merchant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availablePaymentProcessors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[PaymentProcessor]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available payment processors configured for the merchant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["avs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AvsOptions?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AVS configuration and settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isCustomerCardSavingByTerminalEnabled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the terminal can save customer's card after transaction processing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ttpIosTerminalProfileId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay Terminal Profile ID for iOS devices."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"apipermission","__idx":124},"children":["ApiPermission"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API permission types"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["posStartTransaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POS: Start a transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["posGetTransactions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POS: Get transactions list."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["posGetTransactionDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POS: Get transaction details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["posCancelTransaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POS: Cancel a transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["posPrintReceipt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POS: Print receipt."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["getTerminalList"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminals: Get terminal list."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["getTerminalInformation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminals: Get terminal information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ecommerceAuth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eCommerce: Authorization."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ecommerceSale"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eCommerce: Sale."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ecommerceCapture"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eCommerce: Capture."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ecommerceVoid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eCommerce: Void."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ecommerceRefund"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eCommerce: Refund."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ecommerceRefundWithoutReference"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["eCommerce: Refund without reference (unlinked refund)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achDebit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH: Debit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achCredit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH: Credit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achVoid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH: Void."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achHold"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH: Hold."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["achUnhold"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ACH: Unhold."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["listTransactions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transactions: List transactions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["getTransactionDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transactions: Get transaction details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["calculateTransactionAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transactions: Calculate transaction amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["submitTipAdjustment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tips: Submit tip adjustment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["getSettlementBatches"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Settlement: Get settlement batches."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["submitBatchForSettlement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Settlement: Submit batch for settlement."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sendReceiptBySms"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Receipts: Send receipt by SMS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["listCustomers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customers: List customers."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["getCustomerDetails"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customers: Get customer details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["manageCustomers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customers: Manage customers (create/update/delete)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostedInvoices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hosted Solutions: Invoices."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostedQuickPayment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hosted Solutions: Quick Payment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostedSubscriptions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hosted Solutions: Subscriptions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hostedWebComponents"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hosted Solutions: Web Components."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["featureTapToPayOnMobile"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Features: Tap to Pay on Mobile, required for Mobile SDK Tap to Pay integration."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["generalPing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["General: Ping."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["generalStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["General: Status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["generalConfigurations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["General: Configurations."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"apipermissionsresponse","__idx":125},"children":["ApiPermissionsResponse"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response containing list of enabled API permissions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[ApiPermission]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of enabled API permissions"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"avsoptions","__idx":126},"children":["AvsOptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Address Verification System (AVS) options."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isEnabled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether AVS is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["profileId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AVS profile identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["profile"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AVS profile name (i.e., \"Strict\", \"Moderate\", “Tolerant”)."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"currencyoption","__idx":127},"children":["CurrencyOption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Currency option with identifier and name."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric currency identifier (ISO 4217)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency code (e.g., \"USD\", \"EUR\")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"namedoption","__idx":128},"children":["NamedOption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generic enum option with identifier and name. Generic structure for representing enumerated options with an identifier and optional name. Used for currencies, card types, transaction types, and other enumerated options."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Readable name."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"paymentprocessor","__idx":129},"children":["PaymentProcessor"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment processor configuration."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique processor identifier (UUID)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Processor name (e.g., \"TSYS\")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isDefault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether this is the default processor."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operationType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OperationType?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["settlementBatchTimeSlots"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[SettlementBatchTimeSlot]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Settlement batch time slots with timezone information."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"settlementbatchtimeslot","__idx":130},"children":["SettlementBatchTimeSlot"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Settlement batch time slot with timezone."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hours"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hours component of the time."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["minutes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int32?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minutes component of the time."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["timezoneName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IANA timezone name (e.g., \"America/New_York\")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"devices","__idx":131},"children":["Devices"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"devicesresponse","__idx":132},"children":["DevicesResponse"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["devices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[DeviceInfo]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Flattened list of devices."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"deviceinfo","__idx":133},"children":["DeviceInfo"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deviceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Device Id."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deviceName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Device name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lastLoginAt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last login time."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tapToPayStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap To Pay status text (e.g., Inactive, Requested)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tapToPayStatusId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap To Pay status identifier (0–4)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tapToPayEnabled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether Tap To Pay feature is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["userProfiles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[DeviceUser]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profiles associated with this device."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"deviceuser","__idx":134},"children":["DeviceUser"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the user profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["firstName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name of the user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lastName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last name of the user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address associated with the profile."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tap-to-pay","__idx":135},"children":["Tap to Pay"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttpcompatibilityresult","__idx":136},"children":["TTPCompatibilityResult"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isCompatible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Overall compatibility status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deviceModelCheck"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DeviceModelCheck"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Device model compatibility check result."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["iosVersionCheck"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IOSVersionCheck"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["iOS version compatibility check result."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["locationPermission"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["LocationPermissionStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location permission status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tapToPayEntitlement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TapToPayEntitlementStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay entitlement availability status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["incompatibilityReasons"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of reasons why the device is not compatible (empty if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["compatible"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"devicemodelcheck","__idx":137},"children":["DeviceModelCheck"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isCompatible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the device model is compatible (iPhone XS or newer)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["modelIdentifier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Device model identifier (e.g., \"iPhone14,2\")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"iosversioncheck","__idx":138},"children":["IOSVersionCheck"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isCompatible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the iOS version is compatible (iOS 18 or newer)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current iOS version string (e.g., \"18.0\")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["minimumRequiredVersion"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required minimum iOS version (e.g., \"18.0\")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"locationpermissionstatus","__idx":139},"children":["LocationPermissionStatus"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["granted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location permission has been granted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["denied"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location permission has been denied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["undetermined"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location permission status is undetermined (not yet requested)."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"taptopayentitlementstatus","__idx":140},"children":["TapToPayEntitlementStatus"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["available"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay entitlement is available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unavailable"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay entitlement is unavailable."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttpstatus","__idx":141},"children":["TTPStatus"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["active"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay is activated and ready to use."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["inactive"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay is not activated."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttpcvmdata","__idx":142},"children":["TTPCVMData"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tag"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVM tag identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["value"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVM tag value."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttptransactionrequest","__idx":143},"children":["TTPTransactionRequest"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Decimal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction amount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tip"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tip amount as string (optional)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["discount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Discount amount as string (optional)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["subTotal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subtotal amount as string (optional)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orderId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order identifier (optional)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["surchargeRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Surcharge rate as string (optional)."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttptransactionresult","__idx":144},"children":["TTPTransactionResult"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction identifier from the payment processor."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionOutcome"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction outcome (APPROVED, DECLINED, etc.)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTPTransactionStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction status derived from transactionOutcome."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orderId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorizedAmount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorized amount as string."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorizationCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization code from the payment processor."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorisationResponseCode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization response code (British spelling)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorizedDate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorized date as string."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authorizedDateFormat"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Format of the authorized date."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cardBrandName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card brand name (e.g., Visa, Mastercard)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["maskedCardNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Masked card number (last 4 digits)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["externalReferenceID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External reference ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["applicationIdentifier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Application identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["applicationPreferredName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Application preferred name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["applicationCryptogram"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Application cryptogram."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["applicationTransactionCounter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Application transaction counter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["terminalVerificationResults"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal verification results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["issuerApplicationData"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Issuer application data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["applicationPANSequenceNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Application PAN sequence number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partnerDataMap"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[String: String]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner data map."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cvmTags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[TTPCVMData]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVM tags."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cvmAction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVM action."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttptransactionstatus","__idx":145},"children":["TTPTransactionStatus"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case"},"children":["Case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["approved"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction was approved by the payment processor."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["declined"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction was declined by the payment processor."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cancelled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction was cancelled by the user or system."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction failed due to an error."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttpevent","__idx":146},"children":["TTPEvent"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case Name"},"children":["Case Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Associated Value"},"children":["Associated Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readerEvent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTPReaderEvent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Low-level events from the card reader. These events come directly from the ProximityReader framework and represent physical card reader state changes and progress updates."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".customEvent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTPCustomEvent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["High-level business logic events from the SDK. These events represent transaction lifecycle and business logic states."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttpreaderevent","__idx":147},"children":["TTPReaderEvent"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case Name"},"children":["Case Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Associated Value"},"children":["Associated Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".updateProgress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Progress update during firmware update or initialization."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".notReady"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reader is not ready."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readyForTap"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reader is ready for card tap."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".cardDetected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card has been detected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".removeCard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card should be removed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readCompleted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card read completed successfully."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readRetry"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card read failed, retry needed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readCancelled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card read was cancelled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".pinEntryRequested"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PIN entry requested on reader."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".pinEntryCompleted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PIN entry completed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".userInterfaceDismissed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User interface was dismissed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readNotCompleted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reader interface not completed."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttpcustomevent","__idx":148},"children":["TTPCustomEvent"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Case Name"},"children":["Case Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Associated Value"},"children":["Associated Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".preparing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal is preparing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".ready"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal is ready."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".readerNotReady"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reader is not ready."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".cardDetected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card has been detected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".cardReadSuccess"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card read succeeded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".cardReadFailure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card read failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".authorizing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment is being authorized."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".approved"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction was approved."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".declined"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction was declined."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".errorOccurred"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An error occurred during the transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".inProgress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction is in progress."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".updateReaderProgress"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reader progress update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[".unknownEvent"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unknown event."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-handling","__idx":149},"children":["Error Handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flute Mobile SDK can throw three main error types to handle different categories of errors:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AriseApiError"]},": Errors that occur during API operations (network errors, HTTP errors, validation errors)"," ","• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TTPError"]},": Errors specific to Tap to Pay operations (activation failures, transaction errors, reader errors)"," ","• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authenticationError"]},": Errors that occur during authentication operations (invalid credentials, token expiration)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All error types conform to Swift's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LocalizedError"]}," protocols, providing consistent error handling across the SDK."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ariseapierror","__idx":150},"children":["AriseApiError"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Errors that can occur during API operations. Centralized error handling for all Flute API clients."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Name"},"children":["Error Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recovery Strategy"},"children":["Recovery Strategy"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["badRequest"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request was malformed or contained invalid parameters."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Please verify the request parameters and try again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication is required or the access token is invalid or expired."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Please call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticate()"]}," method to obtain a valid access token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["forbidden"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You do not have permission to perform this action."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You do not have permission to perform this action. Please check your access rights."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["notFound"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The requested resource does not exist."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You are trying to access a resource that does not exist. Please verify the resource identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["serverError"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server encountered an error while processing the request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server encountered an error. Please try again after a short delay."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unknown"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unexpected error occurred that doesn't match any known error type."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unexpected error occurred. Please try again or contact support if the issue persists."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["invalidResponse"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server returned an unexpected response format."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server returned an unexpected response. This may indicate an API change or a temporary server issue."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["networkError"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A network error occurred (connection timeout, no internet, etc.)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check your internet connection and try again."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttperror","__idx":151},"children":["TTPError"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Errors that can occur during Tap to Pay operations."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Name"},"children":["Error Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recovery Strategy"},"children":["Recovery Strategy"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["notCompatible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Thrown when the device fails one or more compatibility checks required for Tap to Pay."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the incompatibilityReasons array to identify specific issues For location permission: Request location permission in your app before calling activate(). The SDK does not request permissions — this is the app's responsibility For device/iOS version: Inform the user that their device does not support Tap to Pay For entitlement issues: Verify the device supports Tap to Pay hardware (NFC capability)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["notActive"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tap to Pay is not activated on the device. The status is not active."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activate()"]}," method to activate Tap to Pay. This may show Apple's terms and conditions screen."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sdkNotInitialized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Tap to Pay SDK is not initialized."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ensure the SDK is properly initialized before calling Tap to Pay methods."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["configurationFailed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTP Error Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Failed to configure the Tap to Pay SDK with merchant information."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check that all required merchant configuration (company name, MCC code, currency code, country code) is available in payment settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["activationFailed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTP Error Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Failed to activate Tap to Pay. This may occur during the activation workflow."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check device compatibility, ensure Apple Terms & Conditions are accepted, and verify merchant configuration. Try calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activate()"]}," again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["transactionFailed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTP Error Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Tap to Pay transaction failed. This can occur due to card reader errors, payment processing errors, or other transaction-related issues."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the error code and message for specific details. Ensure the card is properly positioned, the reader is ready, and the transaction amount is valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["failedToAbortTransaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTP Error Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Failed to abort an in-progress transaction. This typically occurs when card reading has already begun."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction cannot be aborted because card reading has already begun. The transaction will complete normally."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unknown"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TTP Error Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unknown error occurred during a Tap to Pay operation."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the error code and message for specific details. If the issue persists, contact support."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ttp-error-codes","__idx":152},"children":["TTP Error Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recoverable"},"children":["Recoverable"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use case for error occurrence"},"children":["Use case for error occurrence"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Possible resolution"},"children":["Possible resolution"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DEV003"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The device does not support Tap to Pay on iOS device."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When a device does not support Tap to Pay on an iOS device. Currently requires iPhone Xs or later."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try a different device."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GPS003"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The device could not be located. Move to a location where a GPS signal can be received"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method or Resume Session method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Restart the app. If not resolved, then contact customer care. This error is also known to be thrown when the Flute Mobile SDK is not initiated in the main thread. Check the Init section for details and examples for proper SDK initialization."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GPS005"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner is not allowed to operate in the current country."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method or Resume Session method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GPS006"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The device could not be located. Move to a location where the GPS signal can be received."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method or Resume Session method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT018"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unable to connect to the server. Please try again later."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A failed attempt to contact the App Attest service during an attestation."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the user is logged in, try logging out and log in back in. Alternatively, reinstall the app."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT019"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The app is missing a team identifier."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Team Identifier not available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specify the team identifier in the information list."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT020"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The app is missing a bundle identifier."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bundle Identifier not available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify the info.plist file, specifically the CFBundleShortVersionString."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT021"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attestation failed. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A one-time challenge from the server is missing, required reduce the risk of replay attacks."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the user is logged in, try logging out and log in back in. Alternatively, reinstall the app."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT022"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attestation failed. Please try again"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The App Attest Service rejects the KeyId. This occurs if there is an issue with generating, retrieving, or using an App Attest cryptographic key."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume Session, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the user is logged in, try logging out and log in back in. Alternatively, reinstall the app."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT023"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attestation failed. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Possible Issues: The app may provide incorrectly formatted data, fail to generate a token, or be unable to access Device Check on this device."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume Session, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the user is logged in, try logging out and log in back in. Alternatively, reinstall the app."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ATT024"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attestation failed. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["App Attestation Service not initialized properly."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Resume Session, or Perform Transaction methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the user is logged in, try logging out and log in back in. Alternatively, reinstall the app."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA001"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The requested object is not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request object JSON is not valid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["_"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the request object parameters and their expected value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA002"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request object. JSON is not valid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the request object parameters and their expected value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA003"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed JSON Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request object. JSON is not valid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check request object parameters and their expected value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA005"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Access denied"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attestation for the device has failed in the past or device linked with POS instance does not match with the device making the request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA008"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error storing information. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keychain data storage error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method or Clear Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA009"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error removing information. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keychain data deletion error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method or Clear Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA010"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error occurred."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keychain security key error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method or Clear Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA011"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null or empty value encountered."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The encryption algorithm is empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DATA012"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unexpected or empty value is encountered."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server response error when JSON decoded"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CRYPTO001"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong on our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Data from public key get failed once performing Certificate pinning."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CRYPTO002"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong on our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JWT decoder or JSON error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CRYPTO003"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong on our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Private key attributes error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CRYPTO004"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong on our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payload data decryption error."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CRYPTO005"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong on our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Public key not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CRYPTO006"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong on our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unsupported encrypted algorithm."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SEC005"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sorry, something went wrong at our end. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Public key expired."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SEC008"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A potential security concern has been identified. Please install the application on another device or contact customer support."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Security protection error."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reinstall the application on your device and contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SEC001"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication token expired."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication token expired."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ask for re-login."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DEC_04"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["We could not validate the information. Please try again."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certificate chain is invalid when fetched from public key data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ask for re-login."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MER003"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant configuration not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MER004"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant display name not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MER005"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant category code not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MER006"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal Profile ID not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MER007"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant currency code not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MER008"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant country code not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact customer care."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EC_02"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some error occurred. Please try again later."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some internal error occurs at the server."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EC_500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal Server Error."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some internal error occurs at the server."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Try again after some time. If the issue continues after multiple attempts, contact customer care for assistance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EC_502"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Gateway"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The origin server did not send a valid response to the API Gateway."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ask the user to try again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EC_503"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service temporarily unavailable."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Origin server not available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ask the user to try again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EC_504"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gateway time-out"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The origin server did not send a valid response to the API Gateway."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure method, Perform Transaction, and Resume Session methods."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ask the user to try again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AUTH_001"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized or authentication Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This can occur if the JWT is expired or invalid."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provide a valid JWT authorization token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MISSING_REQUIRED_FIELD"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing required field subMerchantId/displayName."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request is invalid."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For the Payment Gateway - Delegated model, this is a mandatory field."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provide sub merchantId/displayName for Payment Gateway - Delegated model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PARTNER_UNAUTHORIZED"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["We are sorry, but this partner does not currently support the operating system. Please contact your partner for assistance."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["There is no support for the iOS Operating system."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Please contact your partner for assistance."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"authenticationerror","__idx":153},"children":["AuthenticationError"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Errors that can occur during authentication operations."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Name"},"children":["Error Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recovery Strategy"},"children":["Recovery Strategy"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["invalidCredentials"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The provided client credentials (clientId and clientSecret) are invalid."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify that the clientId and clientSecret are correct. Ensure credentials are not expired or revoked."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["networkError"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A network error occurred during authentication (connection timeout, no internet, etc.)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check your internet connection and try again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["invalidResponse"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The authentication server returned an invalid or unexpected response."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server returned an unexpected response. This may indicate an API change or a temporary server issue. Try again after a short delay."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tokenExpired"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The access token has expired."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refreshAccessToken()"]}," to obtain a new access token, or call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticate()"]}," again with valid credentials."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unknown"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unknown error occurred during authentication."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unexpected error occurred. Please try again or contact support if the issue persists."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"paymentcardreadererror","__idx":154},"children":["PaymentCardReaderError"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Errors that can be thrown by iOS ProximityReader framework."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Name"},"children":["Error Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recovery Strategy"},"children":["Recovery Strategy"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ProximityReader.PaymentCardReaderError error 0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error 0 (notAllowed)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error 0 (notAllowed) in ProximityReader means the system has blocked the Tap to Pay session. This usually happens because the app's configuration, merchant account, or Apple ID environment doesn't match the required security or entitlement settings."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check Entitlements: Ensure com.apple.developer.proximity-reader.payment.acceptance is in your .entitlements file and active in the Apple Developer Portal. Match Environments: Use a Sandbox Apple ID (not a real one) for non-production testing to avoid environment conflicts. Verify Device: Ensure you are using an iPhone XS or later, it has a passcode enabled, and the region is supported."]}]}]}]}]}]},"headings":[{"value":"Flute Mobile SDK for iOS","id":"flute-mobile-sdk-for-ios","depth":1},{"value":"Changelog","id":"changelog","depth":2},{"value":"Overview","id":"overview","depth":2},{"value":"Who Should Use This SDK","id":"who-should-use-this-sdk","depth":4},{"value":"What You Can Build","id":"what-you-can-build","depth":4},{"value":"Key Features","id":"key-features","depth":3},{"value":"Tap to Pay on iPhone","id":"tap-to-pay-on-iphone","depth":4},{"value":"Unified Transaction API","id":"unified-transaction-api","depth":4},{"value":"Secure by Design","id":"secure-by-design","depth":4},{"value":"Zero Cost Processing Support","id":"zero-cost-processing-support","depth":4},{"value":"Architecture Overview","id":"architecture-overview","depth":3},{"value":"Integration Patterns","id":"integration-patterns","depth":3},{"value":"Simple Payment Flow","id":"simple-payment-flow","depth":4},{"value":"Advanced Payment Flow","id":"advanced-payment-flow","depth":4},{"value":"Asynchronous Tasks Support","id":"asynchronous-tasks-support","depth":4},{"value":"Getting Help","id":"getting-help","depth":3},{"value":"Get Started","id":"get-started","depth":2},{"value":"Obtain Client Credentials","id":"obtain-client-credentials","depth":3},{"value":"For Merchants","id":"for-merchants","depth":4},{"value":"For Affiliates / ISV Partners","id":"for-affiliates--isv-partners","depth":4},{"value":"Environments","id":"environments","depth":3},{"value":"Sandbox Environment","id":"sandbox-environment","depth":4},{"value":"Production Environment","id":"production-environment","depth":4},{"value":"System Requirements","id":"system-requirements","depth":3},{"value":"Minimum iOS Version","id":"minimum-ios-version","depth":4},{"value":"Supported Devices","id":"supported-devices","depth":4},{"value":"Dependencies","id":"dependencies","depth":4},{"value":"Required Entitlements and Capabilities","id":"required-entitlements-and-capabilities","depth":3},{"value":"For General Integration","id":"for-general-integration","depth":4},{"value":"For Tap to Pay on iPhone","id":"for-tap-to-pay-on-iphone","depth":4},{"value":"1. Apply for the Tap to Pay on iPhone Entitlement","id":"1-apply-for-the-tap-to-pay-on-iphone-entitlement","depth":5},{"value":"2. Configure Xcode Capabilities","id":"2-configure-xcode-capabilities","depth":5},{"value":"3. Update Info.plist","id":"3-update-infoplist","depth":5},{"value":"4. Entitlements File","id":"4-entitlements-file","depth":5},{"value":"Testing","id":"testing","depth":3},{"value":"Quick Start Checklist","id":"quick-start-checklist","depth":3},{"value":"Next Steps","id":"next-steps","depth":3},{"value":"Installation & Setup","id":"installation--setup","depth":2},{"value":"Methods Specification – Init and Session Management","id":"methods-specification--init-and-session-management","depth":2},{"value":"Init","id":"init","depth":3},{"value":"Authenticate","id":"authenticate","depth":3},{"value":"Get Access Token","id":"get-access-token","depth":3},{"value":"Refresh Access Token","id":"refresh-access-token","depth":3},{"value":"Clear Stored Token","id":"clear-stored-token","depth":3},{"value":"Methods Specification – Transactions","id":"methods-specification--transactions","depth":2},{"value":"Get Transactions List","id":"get-transactions-list","depth":3},{"value":"Get Transaction Details","id":"get-transaction-details","depth":3},{"value":"Submit an Authorization Transaction (AUTH)","id":"submit-an-authorization-transaction-auth","depth":3},{"value":"Submit a Sale Transaction (SALE)","id":"submit-a-sale-transaction-sale","depth":3},{"value":"Void a Transaction (VOID)","id":"void-a-transaction-void","depth":3},{"value":"Capture a Transaction (CAPTURE)","id":"capture-a-transaction-capture","depth":3},{"value":"Refund a Transaction (REFUND)","id":"refund-a-transaction-refund","depth":3},{"value":"Calculate Amount","id":"calculate-amount","depth":3},{"value":"Methods Specification - Tap to Pay","id":"methods-specification---tap-to-pay","depth":2},{"value":"Check Compatibility","id":"check-compatibility","depth":3},{"value":"Get Status","id":"get-status","depth":3},{"value":"Activate","id":"activate","depth":3},{"value":"Show Educational Information","id":"show-educational-information","depth":3},{"value":"Prepare the Card Reader","id":"prepare-the-card-reader","depth":3},{"value":"Perform a Tap To Pay Transaction","id":"perform-a-tap-to-pay-transaction","depth":3},{"value":"Tap To Pay Transaction with Credit Card Surcharge","id":"tap-to-pay-transaction-with-credit-card-surcharge","depth":4},{"value":"Abort Transaction","id":"abort-transaction","depth":3},{"value":"Events Stream","id":"events-stream","depth":3},{"value":"Methods Specification - Settings","id":"methods-specification---settings","depth":2},{"value":"Get Payment Settings","id":"get-payment-settings","depth":3},{"value":"Get Permissions","id":"get-permissions","depth":3},{"value":"Methods Specification – Device Management","id":"methods-specification--device-management","depth":2},{"value":"Get Devices","id":"get-devices","depth":3},{"value":"Get Device Info","id":"get-device-info","depth":3},{"value":"Get Device ID","id":"get-device-id","depth":3},{"value":"Methods Specification – General Information","id":"methods-specification--general-information","depth":2},{"value":"Get SDK Version","id":"get-sdk-version","depth":3},{"value":"API Models","id":"api-models","depth":2},{"value":"Transactions","id":"transactions","depth":3},{"value":"TransactionFilters","id":"transactionfilters","depth":4},{"value":"CreateMethodId","id":"createmethodid","depth":4},{"value":"Currency","id":"currency","depth":4},{"value":"ZeroCostProcessingOption","id":"zerocostprocessingoption","depth":4},{"value":"OperationType","id":"operationtype","depth":4},{"value":"PaymentMethodType","id":"paymentmethodtype","depth":4},{"value":"AccountType","id":"accounttype","depth":4},{"value":"AccountHolderType","id":"accountholdertype","depth":4},{"value":"TransactionType","id":"transactiontype","depth":4},{"value":"TransactionStatus","id":"transactionstatus","depth":4},{"value":"TransactionsResponse","id":"transactionsresponse","depth":4},{"value":"TransactionSummary","id":"transactionsummary","depth":4},{"value":"CardTokenType","id":"cardtokentype","depth":4},{"value":"SourceResponseDto","id":"sourceresponsedto","depth":4},{"value":"AvailableOperation","id":"availableoperation","depth":4},{"value":"SuggestedTipsDto","id":"suggestedtipsdto","depth":4},{"value":"AmountDto","id":"amountdto","depth":4},{"value":"TransactionDetails","id":"transactiondetails","depth":4},{"value":"TransactionAmountDto","id":"transactionamountdto","depth":4},{"value":"CardDetailsDto - TransactionDetails","id":"carddetailsdto---transactiondetails","depth":4},{"value":"ElectronicCheckDetails  - TransactionDetails","id":"electroniccheckdetails----transactiondetails","depth":4},{"value":"AvsResponseDto - TransactionDetails","id":"avsresponsedto---transactiondetails","depth":4},{"value":"EmvTagsDto - TransactionDetails","id":"emvtagsdto---transactiondetails","depth":4},{"value":"TsysCardDetailsDto","id":"tsyscarddetailsdto","depth":4},{"value":"AchDetailsDto","id":"achdetailsdto","depth":4},{"value":"CardTokenType - TransactionDetails","id":"cardtokentype---transactiondetails","depth":4},{"value":"CardholderAuthenticationMethod - TransactionDetails","id":"cardholderauthenticationmethod---transactiondetails","depth":4},{"value":"CardDataSource - TransactionDetails","id":"carddatasource---transactiondetails","depth":4},{"value":"CardTransactionRequest","id":"cardtransactionrequest","depth":4},{"value":"CardTransactionResponse","id":"cardtransactionresponse","depth":4},{"value":"CardDataSource - AuthRequest","id":"carddatasource---authrequest","depth":4},{"value":"AddressDto","id":"addressdto","depth":4},{"value":"ContactInfoDto","id":"contactinfodto","depth":4},{"value":"EMVFallbackCondition","id":"emvfallbackcondition","depth":4},{"value":"EMVFallbackLastChipRead","id":"emvfallbacklastchipread","depth":4},{"value":"TransactionResponseDetailsDto","id":"transactionresponsedetailsdto","depth":4},{"value":"TransactionReceiptDto","id":"transactionreceiptdto","depth":4},{"value":"CardTokenType - Receipt","id":"cardtokentype---receipt","depth":4},{"value":"CardholderAuthenticationMethod - Receipt","id":"cardholderauthenticationmethod---receipt","depth":4},{"value":"CardDetailsDto - Receipt","id":"carddetailsdto---receipt","depth":4},{"value":"ElectronicCheckDetails - Receipt","id":"electroniccheckdetails---receipt","depth":4},{"value":"TransactionOperation","id":"transactionoperation","depth":4},{"value":"AvsResponseDto - AuthResult-Receipt","id":"avsresponsedto---authresult-receipt","depth":4},{"value":"EmvTagsDto - Receipt","id":"emvtagsdto---receipt","depth":4},{"value":"TransactionResponse","id":"transactionresponse","depth":4},{"value":"RefundRequest","id":"refundrequest","depth":4},{"value":"CalculateAmountRequest","id":"calculateamountrequest","depth":4},{"value":"CalculateAmountResponse","id":"calculateamountresponse","depth":4},{"value":"Settings","id":"settings","depth":3},{"value":"PaymentSettingsResponse","id":"paymentsettingsresponse","depth":4},{"value":"ApiPermission","id":"apipermission","depth":4},{"value":"ApiPermissionsResponse","id":"apipermissionsresponse","depth":4},{"value":"AvsOptions","id":"avsoptions","depth":4},{"value":"CurrencyOption","id":"currencyoption","depth":4},{"value":"NamedOption","id":"namedoption","depth":4},{"value":"PaymentProcessor","id":"paymentprocessor","depth":4},{"value":"SettlementBatchTimeSlot","id":"settlementbatchtimeslot","depth":4},{"value":"Devices","id":"devices","depth":3},{"value":"DevicesResponse","id":"devicesresponse","depth":4},{"value":"DeviceInfo","id":"deviceinfo","depth":4},{"value":"DeviceUser","id":"deviceuser","depth":4},{"value":"Tap to Pay","id":"tap-to-pay","depth":3},{"value":"TTPCompatibilityResult","id":"ttpcompatibilityresult","depth":4},{"value":"DeviceModelCheck","id":"devicemodelcheck","depth":4},{"value":"IOSVersionCheck","id":"iosversioncheck","depth":4},{"value":"LocationPermissionStatus","id":"locationpermissionstatus","depth":4},{"value":"TapToPayEntitlementStatus","id":"taptopayentitlementstatus","depth":4},{"value":"TTPStatus","id":"ttpstatus","depth":4},{"value":"TTPCVMData","id":"ttpcvmdata","depth":4},{"value":"TTPTransactionRequest","id":"ttptransactionrequest","depth":4},{"value":"TTPTransactionResult","id":"ttptransactionresult","depth":4},{"value":"TTPTransactionStatus","id":"ttptransactionstatus","depth":4},{"value":"TTPEvent","id":"ttpevent","depth":4},{"value":"TTPReaderEvent","id":"ttpreaderevent","depth":4},{"value":"TTPCustomEvent","id":"ttpcustomevent","depth":4},{"value":"Error Handling","id":"error-handling","depth":3},{"value":"AriseApiError","id":"ariseapierror","depth":4},{"value":"TTPError","id":"ttperror","depth":4},{"value":"TTP Error Codes","id":"ttp-error-codes","depth":4},{"value":"AuthenticationError","id":"authenticationerror","depth":4},{"value":"PaymentCardReaderError","id":"paymentcardreadererror","depth":4}],"frontmatter":{"title":"iOS","description":"A step-by-step guide for deploying your Flute payment integration to Production, covering readiness checks, security, credentials, go-live testing, monitoring, and post-launch optimization.","seo":{"title":"Flute Mobile SDK for iOS"}},"lastModified":"2026-06-15T13:50:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/sdk/ios","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}