LogoLogo
  • Platform Overview
  • 🗺️Guides
    • Getting Started
    • Users
      • Integrate the User SDK
      • Registration
      • Authentication
      • SDK Releases
      • API Reference
    • Entitlements
      • Administrative API
        • Integrating the Administrative API
        • Entitlement Definitions
        • Managing Entitlements Sets
        • Managing Entitlements Sequences
        • Managing User Entitlements
        • API Schema
      • End-user API
        • Integrate the Entitlements SDK
        • Redeeming Entitlements
        • Retrieving Entitlements
        • SDK Releases
        • API Reference
    • Sudos
      • Integrate the Sudo Profiles SDK
      • Sudo Entitlements
      • Manage Sudos
      • SDK Releases
      • API Reference
    • Telephony
      • Integrate the Telephony SDK
      • Manage Phone Numbers
      • Text Messaging
      • Voice Calling
      • Telephony Simulator
      • SDK Releases
      • API Reference
    • Email
      • Integrate the Email SDK
      • Email Entitlements
      • Manage Email Addresses
      • Sending & Receiving Email
      • Manage Email Folders
      • Draft Email Messages
      • Manage Email Address Blocklists
      • Email Address Public Information
      • Pagination
      • Caching
      • Configuration Data
      • Email Notifications
      • SDK Releases
      • API Reference
    • Decentralized Identity
      • Edge Agent
        • Relay SDK
          • Integrate the Relay SDK
          • Relay Entitlements
          • Manage Relay Postboxes
          • Manage Relay Messages
          • Receiving Messages
          • SDK Releases
        • Edge Agent SDK
          • Integrate the Edge Agent SDK
          • Agent Management
          • Manage Wallets
          • Establishing Connections
          • Manage Connections
          • Messaging
          • Manage DIDs
          • Accepting New Credentials
          • Manage Credentials
          • Present Credentials for Verification
          • Utilize Alternative Cryptography Providers
          • SDK Releases
          • Standards and Protocols
      • Cloud Agent
        • Cloud Agent Admin API
          • Integrate the Cloud Agent Admin API
          • Aries Interop Profile (AIP)
            • Connection Exchanges
            • Credential Exchanges
            • Proof Exchanges
          • Connections
          • Basic Messages
          • Credentials
            • Anoncreds Credentials
              • Schemas
              • Credential Definitions
            • W3C Credentials
          • Audit Logs
          • API Schema
          • Error Codes
          • Standards and Protocols
    • Virtual Cards
      • Integrate the Virtual Cards SDK
      • Virtual Cards Entitlements
      • Virtual Cards Transaction Velocity Constraints
      • Key Management
      • Manage Funding Sources
      • Manage Virtual Cards
      • Manage Transactions
      • Configuration Data
      • Pagination
      • Caching
      • SDK Releases
      • API Reference
    • Virtual Cards Simulator
      • Integrate the Virtual Cards Simulator SDK
      • Simulate Authorizations
      • Simulate Debits
      • Simulate Refunds
      • Simulate Reversals
      • Merchants and Currencies
      • SDK Releases
      • API Reference
    • Virtual Private Network
      • Integrate the VPN SDK
      • VPN Entitlements
      • Manage Servers
      • Manage Connection
      • Observe VPN Related Events
      • SDK Releases
      • API Reference
      • Frequently Asked Questions
    • Secure ID Verification
      • Integrate the Secure ID Verification SDK
      • List Supported Countries
      • Verify an Identity
      • Check Secure ID Verification Status
      • Use the Secure ID Verification Simulator
      • SDK Releases
      • API Reference
    • Password Manager
      • Integrate the Password Manager SDK
      • Accessing the Password Manager
      • Managing Password Vaults
      • Managing Password Vault Items
      • Vault Import and Export
      • Password Utilities
      • Password Manager Entitlements
      • Password Vault Security
      • SDK Releases
      • API Reference
    • Ad/Tracker Blocker
      • Integrate the Ad/Tracker Blocker SDK
      • Manage Rulesets
      • Blocking Ads and Trackers
      • Manage Exceptions
      • SDK Releases
      • API Reference
    • Site Reputation
      • Integrate the Site Reputation SDK
      • Use the Site Reputation SDK
      • SDK Releases
      • API Reference
  • 💡Concepts
    • Sudo Digital Identities
  • 🧱Development
    • Versioning
  • 🏢Administration
    • Admin Console Roles
  • ❓Get Help
    • Request a Demo
    • Report an Issue
Powered by GitBook
On this page
  • Prerequisites
  • Get Started
  • Integrate the JS SDK
  • Integrate the iOS SDK
  • SDK Configuration
  • Client Initialization
  • Integrate the Android SDK
  • SDK Configuration
  • Client Initialization
  • Threading Considerations
  1. Guides
  2. Virtual Cards Simulator

Integrate the Virtual Cards Simulator SDK

Integrate the Virtual Cards Simulator SDK into your application

PreviousVirtual Cards SimulatorNextSimulate Authorizations

Last updated 7 months ago

Prerequisites

Get Started

Integrate the JS SDK

To use the Virtual Cards Simulator SDK in a Web or Node.js project, you must add @sudoplatform/sudo-virtual-cards as a dependency to your project.

yarn add '@sudoplatform/sudo-virtual-cards-simulator'
# or
npm install --save '@sudoplatform/sudo-virtual-cards-simulator'

To instantiate and initialize a client in your application, add the following:

const SimApiConfig = t.type({
  apiUrl: t.string,
  apiKey: t.string,
  region: t.string,
})
type SimApiConfig = t.TypeOf<typeof SimApiConfig>

const setupApiClient = (): AWSAppSyncClient<NormalizedCacheObject> => {
  const config =
    DefaultConfigurationManager.getInstance().bindConfigSet<SimApiConfig>(
      SimApiConfig,
      'vcSimulator',
    )
  return new AWSAppSyncClient({
    disableOffline: true,
    url: config.apiUrl,
    region: config.region,
    auth: {
      type: AUTH_TYPE.API_KEY,
      apiKey: config.apiKey,
    },
  })
}

const client = setupApiClient()
const virtualCardsSimulatorClient =
  new DefaultSudoVirtualCardsSimulatorClient({ appSyncClient: client })

Integrate the iOS SDK

If your project has not already been initialized for Cocoapods then run the following command from the project's root directory.

pod init

Open the Podfile in a text editor and add the SudoVirtualCardsSimulator pod as a dependency to your application. Your Podfile should look like this example:

Podfile
target 'YOUR-APP-NAME' do
  use_frameworks!
  pod 'SudoVirtualCardsSimulator'
end

Install the pod dependencies by running the following command:

pod install --repo-update

SDK Configuration

Simulator configuration differs from the configuration of the other Sudo Platform SDKs. Please take note of this section.

The Simulator configuration differs from the configuration you will have seen in the other Sudo Platform SDKs. It requires:

  • username

  • password

  • endpoint

  • region

The username and password are your login credentials for the Sudo Platform Administration Console.

Do not commit sensitive information, such as your username and password, within your code repository.

Client Initialization

To instantiate a client in your application, add the following code.

do {
    let username = // Username obtained from the Sudo Platform Admin Console
    let password = // Password obtained from the Sudo Platform Admin Console
    let simulatorClient = try DefaultSudoVirtualCardsSimulatorClient(
        username: username, 
        password: password
    )
} catch {
    // Handle initialization error. An error might be thrown due to invalid
    // configuration.
}

Integrate the Android SDK

Add this line to the dependencies section of the app module's build.gradle then synchronize your project with Android Studio.

build.gradle
dependencies {
    implementation 'com.sudoplatform:sudovirtualcardssimulator:$latest_version'
}

SDK Configuration

Simulator configuration differs from the configuration of the other Sudo Platform SDKs. Please take note of this section.

The Simulator configuration differs from the configuration you will have seen in the other Sudo Platform SDKs. It requires:

  • username

  • password

  • endpoint

  • region

You can obtain the username and password from the Sudo Platform Administration Console under the Project Settings -> Mobile App Config section. This username and password are your login credentials for the Sudo Platform Administration Console.

Do not commit sensitive information, such as your username and password, within your code repository.

Client Initialization

To instantiate a client in your application, add the following code.

val username = // Username obtained from the Sudo Platform Admin Console
val password = // Password obtained from the Sudo Platform Admin Console

val simulatorClient = SudoVirtualCardsSimulatorClient.builder()
    .setContext(appContext)
    .setUsername(username)
    .setPassword(password)
    .build()

Threading Considerations

The methods of this API shown in the code samples perform synchronous network requests to the simulator provider. Therefore, these methods should be called with the Dispatchers.IO coroutine dispatcher so that the network request is performed on an I/O thread and not on the main thread.

Calling these methods on the main thread may cause a NetworkOnMainThreadException

The is open source and compatible with iOS 11 and above.

To use the Virtual Cards Simulator SDK in an iOS App you must install SudoVirtualCardsSimulator via .

The endpoint and region are contained in the SDK configuration file that you can download as described in the section.

The is open source and compatible with Android 6 (API level 23) and above.

The latest version of the SDK can be found at .

In order to instantiate a Virtual Cards Simulator client, make sure you have followed the instructions for (see Prerequisities above)

The endpoint and region are contained in the SDK configuration file that you can download as described in the section.

🗺️
iOS SDK
Cocoapods
Android SDK
SDK Releases
Getting Started
Complete the Getting Started Guide
Integrate the JS SDK
Integrate the iOS SDK
Integrate the Android SDK
Getting Started
Getting Started