UserLink Transact SDK Reference

The Atomic Transact SDK is a UI designed to securely handle interactions with our products while performing the heavy-lifting of integration.

iOS

Libraries

iOS

The Transact iOS SDK can be installed either with the Swift Package Manager or through CocoaPods.

Requirements

Xcode 12.0 or greater
iOS 13.0 or greater

Swift Package Manager

Inside Xcode, go to Project Settings -> Project -> Package Dependencies and click the + to add a new Package.

Enter the Package URL

https://github.com/atomicfi/atomic-transact-ios

CocoaPods

Installation

pod 'AtomicSDK'
# pod 'AtomicSDK/SwiftUI'

The AtomicConfig class can be used to customize the Transact experience using any of the Transact SDK Parameters.

UIKit Example

import AtomicTransact

// Your implementation goes here

let config = AtomicConfig(publicToken: "6e93549e-3571-4f57-b0f7-77b7cb0b5e48", tasks: [.init(operation: .deposit)])

Atomic.presentTransact(from: self, config: config, onInteraction: { interaction in
    print("Interaction event: \(interaction.name) \(interaction.value)")
  }, onCompletion: { result in
  switch result {
    case .finished(let response):
      print("Finish event: \(response.taskId) \(response.handoff)")
    case .closed(let response):
      print("Close event: \(response.reason)")
    case .error(let error):
      print("Transact returned with error: \(error)")
  }
})

SwiftUI Example

import AtomicTransact
import AtomicTransactSwiftUI

// Your implementation goes here

struct MyView: View {
  @State var showingTransact = false
  
  var body: some View {
    // Your implementation goes here
    .atomicTransact(
      isPresented: $showingTransact,
      config: {
        AtomicConfig(publicToken: "6e93549e-3571-4f57-b0f7-77b7cb0b5e48", tasks: [.init(operation: .deposit)])
      },
      onCompletion: { result in
        switch result {
        case .finished(let response):
          print("Finish event: \(response.taskId) \(response.handoff)")
        case .closed(let response):
          print("Close event: \(response.reason)")
        case .error(let error):
          print("Transact returned with error: \(error)")
        }
      })
      .onReceive(Atomic.interactions) { interaction in
        print("Interaction event: \(interaction.name) \(interaction.value)")
      }
  }
}

Android

Update your project plugins

In your root-level (project-level) Gradle file (build.gradle), add rules to include the Android Gradle plugin. Check that you have Google's Maven repository as well.

build.gradle (Project-level)

buildscript {
  repositories {
    // Check that you have the following line (if not, add it):
    google()  // Google's Maven repository
    mavenCentral() // Include to import Transact Android SDK
  }
  dependencies {
    // ...
  }
}

Add the Transact SDK to your app

In your module (app-level) Gradle file (usually app/build.gradle), add a line to the bottom of the file. The latest version of the SDK is Maven Central .

build.gradle (App-level)

android {
  defaultConfig {
    minSdkVersion 21 // or greater
  }

  // Enable Java 8 support for Transact to work
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

dependencies {
  // ...
  implementation 'financial.atomic:transact:<insert latest version>'
}

Change the Transact theme

You have the ability to modify your theme by adding an activity tag. Add the following snippet to your manifest:

Themed TransactActivity

<activity
  android:name="financial.atomic.transact.activity.TransactActivity"
  android:theme="@style/Theme.You.Want"
  />

If you get a Manifest merger failed error, you can resolve it by adding xmlns:tools="http://schemas.android.com/tools" to your manifest tag, then updating your TransactActivity to the following:

Themed TransactActivity with Tool

<activity
  android:name="financial.atomic.transact.activity.TransactActivity"
  android:theme="@style/Theme.You.Want"
  tools:replace="theme"
  />

Kotlin Example

import org.json.JSONObject
import financial.atomic.transact.*
import financial.atomic.transact.receiver.TransactBroadcastReceiver

// Your implementation goes here

val config = Config(
  publicToken = "6e93549e-3571-4f57-b0f7-77b7cb0b5e48",
  tasks = listOf(Config.Task(product = Config.Product.DEPOSIT)))
)

Transact.registerReceiver(context, object: TransactBroadcastReceiver() {
  override fun onClose(data: JSONObject) {
    Log.d("APP", "Close event: ${data.getString("reason")}")
  }
  override fun onFinish(data: JSONObject) {
    Log.d("APP", "Finish event: ${data.getString("taskId")} ${data.optString("handoff")}")
  }
  override fun onInteraction(data: JSONObject) {
    Log.d("APP", "Interaction event: ${data.getString("name")} ${data.getJSONObject("value")}")
  }
})

Transact.present(context, config)

React Native

Transact can be initialized by including our React Native SDK in your app and then calling the Atomic.transact method and passing it a configuration object.

Installation

yarn add @atomicfi/transact-react-native

iOS Setup

Xcode 12.0 or greater
iOS 13.0 or greater

Install CocoaPods Dependencies

(cd ios && pod install)

For applications using the Expo managed workflow, see the Expo documentation about using Native Modules.

Android Setup

Autolinking should set up everything when building.

React Native Example

import { Atomic, Product } from "@atomicfi/transact-react-native"

// Your implementation goes here

Atomic.transact({
  config: {
    publicToken: "6e93549e-3571-4f57-b0f7-77b7cb0b5e48",
    tasks: [{ product: Product.DEPOSIT }]
  },
  onInteraction: interaction => {
    console.log('Interaction event:', interaction.name, interaction.value)
  },
  onFinish: data => {
    console.log('Finish event:', data.taskId, data.handoff)
  },
  onClose: data => {
    console.log('Close event:', data.reason)
  }
})

Flutter

A Flutter plugin that wraps the native Atomic Transact SDKs. View the plugin with a code example on Github

Add atomic_transact_flutter as a dependency in your pubspec.yaml file

Dependency in pubspec.yaml file

dependencies:
  ...
  atomic_transact_flutter: <version>

iOS Requirements

Xcode 12.0 or greater
iOS 13.0 or greater

Android Requirements

Set the minSdkVersion in android/app/build/gradle

Minimum SDK Version

android {
  defaultConfig {
    minSdkVersion 21 // or greater
  }
}

Flutter Example

import 'package:atomic_transact_flutter/atomic_transact_flutter.dart';
// Your implementation goes here

Atomic.transact(
  config: AtomicConfig(
    publicToken: "6e93549e-3571-4f57-b0f7-77b7cb0b5e48",
    tasks: [AtomicTask(product: AtomicProductType.deposit)],
  ),
  onInteraction: (AtomicTransactInteraction interaction) {
    print("onInteraction");
  },
  onDataRequest: (AtomicTransactDataRequest request) {
    print("onDataRequest");
  },
  onCompletion: (AtomicTransactCompletionType type,
      AtomicTransactResponse? response, AtomicTransactError? error) {
    print("onCompletion");
  },
);

Parameters

When using the Transact SDK, the configuration object can be customized to change the look and user experience. Below are all of the available options for customization.

You can listen to client-side events using callback functions like onFinish, onClose, and onInteraction. Light branding customizations can be applied through the theme object, allowing you to set brand colors and toggle dark mode. For Spanish-speaking users, you can set language: 'es' to display all content in Spanish.

Required Properties

publicTokenstring

The public token returned during AccessToken creation.

tasks[TaskConfiguration]

Defines configuration for the tasks you wish to execute as part of the task workflow.

Child Properties

Required Properties

operationstring: Specifies the operation with which to initialize Transact. One of deposit, verify, or tax.
productstringDeprecated: One of deposit, verify, or tax. This is deprecated in favor of operation. product will be available for the foreseeable future and we will give ample warning when it is planned to be sunset.

Optional Properties

onCompletestring

The action to take on completion of the task. Can be either "continue" or "finish." To execute the next task, use "continue." To finish the task workflow and not execute any of the subsequent tasks, use "finish."

Default value: "continue"

onFailstring

The action to take on failure of the task. Can be either "continue" or "finish." To execute the next task, use "continue." To finish the task workflow and not execute any of the subsequent tasks, use "finish."

Default value: "continue"

distributionobject

Optionally pass in enforced deposit settings. Enforcing deposit settings will eliminate company search results that do not support the distribution settings.

Child Properties

Required Properties

typestring: Can be total to indicate the remaining balance of their paycheck, fixed to indicate a specific dollar amount, or percent to indicate a percentage of their paycheck.

Optional Properties

amountnumber

When distribution.type is fixed, it indicates a dollar amount to be used for the distribution. When distribution.type is percent, it indicates a percentage of a paycheck. This is not required if distribution.type is total.

This value cannot be updated by the user unless canUpdate is set to true.

canUpdateboolean

Allows a user to specify any amount they would like, overwriting the default amount.

Default value: false

Optional Properties

onFinishfunction

A function that is called when the user finishes the transaction. The function will receive a data parameter which contains metadata about the executed task.

onClosefunction

Called when the user exits Transact prematurely.

onInteractionfunction

Called when the user interacts with Transact.

themeobject

Object containing properties to customize the look of Transact.

Child Properties

Optional Properties

brandColorstring

Accepts valid values for use with the color CSS property. For example: #FF0000 or rgb(255, 0, 0). This property will mostly be applied to buttons.

darkboolean

Change the overall theme to be dark mode.

displaystring

This value is used to control how Transact is rendered inside your app. By default, if this value is not set, Transact will open in a modal. If set to inline, Transact will be rendered in an iframe. When using inline, pass the CSS selector for the container element in to the container parameter and the Transact iframe will be injected into that element.

containerstring

String containing the CSS selector for rendering Transact inside an iframe. This field is only necessary if you are passing "inline" to theme.display.

overlayColorstring

Accepts valid values for use with the background-color CSS property. For example: #FF0000 or rgb(255, 0, 0). This property will change the overlay background color. This overlay is mainly only seen when Transact is used on a Desktop.

navigationOptionsobject

Object containing properties to customize the navigation bar.

Child Properties

Optional Properties

showBackButtonboolean

Determines if the back button is visible in the navigation bar. When true, the back button is displayed, allowing users to navigate to the previous screen. Defaults to true if no value is provided.

showBackButtonTextboolean

Controls the visibility of the text label next to the back button. When true, a text label will appear alongside the back button. Defaults to false if no value is provided.

showCloseButtonboolean

Determines if the close button is displayed in the navigation bar. When true, the close button is available for users to exit the view. Defaults to true if no value is provided.

deeplinkobject

Object containing properties to deeplink users into a specific step.

Child Properties

Required Properties

stepstring: Acceptable values are search-company and login-company. If the value is login-company, then the companyId is required.

Optional Properties

companyIdstring

Required if the step is login-company. Accepts the ID of the company or the payroll provider.

handoff[string]

Handoff allows views to be handled outside of Transact. In place of the view, corresponding SDK events will be emitted that allows apps to respond and handle these views. Accepts an array. The available values are: exit-prompt, authentication-success, and high-latency. See Handoff Pages for more details.

languagestring

Optionally pass in a language. Acceptable values: en for English and es for Spanish.

Default value: en

linkedAccountstring

Optionally pass the _id of a LinkedAccount. When used, Transact will immediately begin authenticating upon opening. This parameter is used when the LinkedAccount's transactRequired flag is set to true.

conversionTokenstring

Optionally pass a conversionToken to initialize Transact for a Conversion opportunity.

searchobject

Optionally, enforce search queries.

Child Properties

Optional Properties

tags[string]

Filters companies by a specific tag. Possible values include gig-economy, payroll-provider, and unemployment.

excludedTags[string]

Exclude companies by a specific tag. Possible values include gig-economy, payroll-provider, and unemployment.

metadataobject

Optionally pass data to Transact that will be returned to you in webhook events. Common use-cases for this include application version, build number, or commit hash for issue tracking and test name and variant for A/B testing.

experimentsobject

Object containing properties to override feature flags found in your Atomic Console settings. This parameter can help run A/B tests on features within Transact.

Child Properties

Optional Properties

fractionalDepositsboolean

Override the Fractional Deposit feature value set within your Atomic Console settings.

inSdkboolean

When false, close buttons and any user-facing CTAs which require hooking into SDK events, such as manual fallback CTAs, are removed from the UI of the client components.

Default value: true

Sample SDK parameters

{
  "publicToken": "PUBLIC_TOKEN",
  "tasks": [
    {
      "operation": "deposit",
      "distribution": {
        "type": "fixed",
        "amount": 50,
        "action": "create"
      }
    }
  ],
  "theme": {
    "brandColor": "#1b1464",
    "overlayColor": "#CCCCCC",
    "navigationOptions": {
      "showBackButton": true,
      "showBackButtonText": false,
      "showCloseButton": true
    }
  },
  "deeplink": {
    "step": "login-company",
    "companyId": "5e4c4d18b7d75c37aac54a8f"
  },
  "language": "en",
  "metadata": {
    "version": "1.2.1",
    "test": "New User Experience",
    "testVariant": "B"
  }
}

Handoff Pages

The following page names can be added to the handoff array to allow views to be handled outside of Transact.

exit-prompt: If the user has reached the login page and decides to exit, they are prompted with a view that asks them to confirm their exit. When exit-prompt is passed into the handoff array, users will no longer be presented with the exit confirmation. The atomic-transact-close event will be triggered in its place. The event will also send the following data: { handoff: 'exit-prompt' }.
authentication-success: When authentication is successful, the user is taken to the success view within Transact. When authentication-success is passed into the handoff array, users will no longer be taken to the success view. The atomic-transact-finish event will be triggered in its place. The event will also send the following data: { handoff: 'authentication-success' }.
high-latency: When authentication takes much longer than expected, the user is taken to the the high latency view within Transact. When high-latency is passed into the handoff array, users will no longer be taken to this view. The atomic-transact-close event will be triggered in its place. The event will also send the following data: { handoff: 'high-latency' }.

Event listeners

When using the SDK, events will be emitted and passed to the native application. Such events allow native applications to react and perform functions as needed. Some events will be passed with a data object with additional information.

onClose: Triggered in several different instances:
If a user does not find their employer, payroll provider, or service provider, the data passed with the event will be { reason: 'zero-search-results' }.
During the Transact process if a user is prompted to keep waiting or exit and they choose to exit, the data passed with the event will be { reason: 'task-pending' }.
At any point if the user clicks on the x the data passed with the event will be { reason: 'unknown' }.
onFinish: Triggered when the user reaches the success screen and closes Transact. The data passed with the event will include the taskId.
onDataRequest: Triggered when additional data is needed to complete a Task. For example, if your implementation is delaying the transit of bank or card data until the user is authenticated. The data passed with the event will be similar to the following: { fields: ['account', 'card'], userId: 'ATOMIC_USER_ID', taskId: 'TASK_ID', identifier: 'YOUR_IDENTIFIER', taskWorkflowId: 'TASK_WORKFLOW_ID' }. The array of fields will contain a list of missing entities, with possible values of account, card, and identity. You will need to use our Update User endpoint to update the user account with the missing data.
onInteraction: Triggered on interactions within Transact. For example, when a user transitions to a new screen or presses the back button. The data passed with the event will be { name: "NAME OF THE EVENT", value: { OBJECT CONTAINING EVENT VALUES } }. Details can be found below in the interaction events list.

Interaction events

These are some of the event names which can appear in an onInteraction event.

This list is not intended to be all-inclusive.

Viewed Access Unauthorized Page: User did not have a valid token
Viewed Authentication Failed Page: User viewed the page indicating authentication failed
Viewed Authentication Paused Page: User viewed the page indicating authentication paused
Viewed Authentication Success Page: User viewed the page indicating authentication was successful
Viewed Distribution Confirmation Page: User viewed the distribution confirmation page
Viewed Expired Token Page: User has an expired token
Viewed Fixed Deposit Amount Page: User viewed the fixed deposit amount page
Viewed Fractional Deposit Error Page: User viewed the fractional deposit error page
Viewed High Latency Page: User viewed the high latency page
Viewed Learn How You Are Protected Page: User viewed the learn how you are protected page
Viewed Login Page: User viewed the login page
Viewed Login Help Page: User viewed the login help page
Viewed Login Recovery Page: User viewed the login recovery page
Viewed Manual Deposit Instructions Page: User viewed manual deposit instructions page
Viewed MFA Page: User viewed the multi factor authentication page
Viewed Percentage Deposit Amount Page: User viewed the percentage deposit amount page
Viewed Search By Company Page: User viewed the search by company page
Viewed Search By Configurable Connector Page: User viewed the search by configurable connector/payroll provider page
Viewed Search By Payroll Page: User viewed the search by payroll page
Viewed Select From Deposit Options Page: User viewed the select from deposit options page
Viewed Select From Multiple Accounts Page: User viewed the select from multiple accounts page
Viewed Select From Multiple Payroll Providers Page: User viwed the select from available payroll providers page
Viewed Terms And Conditions Are Required Page: User viewed the terms and conditions required page
Viewed Terms And Conditions Page: User viewed the terms and conditions page
Viewed Under Maintenance Page: User viewed a company/payroll provider that is under maintenance
Viewed Welcome Page: User viewed the welcome page

Sample interaction event

{
  "name": "Viewed Access Unauthorized Page",
  "value": {
    "customer": "Atomic",
    "language": "en",
    "product": "deposit"
  }
}

Other events

This includes a subset of our other events.

Search By Company: User has searched for a company/employer
Search By Payroll: User has searched for a payroll provider
Initialized Task: Sent when a task has been created. Includes taskId and taskWorkflowId in the value object.

Metadata

When initializing the Transact SDK you can pass in a metadata parameter. This parameter is used to attach key-value data that will be returned in webhook events and client-side events.

Metadata is useful for storing additional, structured information on a Task. As an example, you could store an order ID from your system to track your user's process with a direct deposit or an identifier for a marketing campaign to track users coming from that content. Metadata is not used by Atomic and won't be seen by your users.

Do not store any sensitive information (bank account numbers, card details, etc.) as metadata.

Sample metadata

{
  "order_id": "1234567890",
  "campaign_id": "email-marketing-campaign"
}

Testing

To aid in testing various user experiences, you may use any of these pre-determined "test" credentials for authentication. Any password will work as long as the username is found in these lists. If the authentication requires an email, simply append @example.com to the end of the chosen username.

Upon submission of your credentials, a test Task is created in Atomic’s system to process the end user’s data. These credentials can be toggled off for production use in the Atomic Console.

These flows operate identically to the way the Atomic system functions in production. Running a test Task will generate the same events and webhooks as a Task run by an end user.

Successful operation

Test where the user's credentials are correct and the task completes. When answering MFA questions, any answer will be accepted.

Username	Phone Number	Description
`test-good`	`(555) 555-0100`	Test a successful operation.
`test-code-mfa`	`(555) 555-0101`	Test an authentication that includes a device code based MFA flow.
`test-push-mfa`	`(555) 555-0102`	Test an authentication that simulates push-based MFA.
`test-question-mfa`	`(555) 555-0103`	Test an authentication that simulates question-based MFA.

Error establishing connection

Test where the user encounters an issue connecting to the third-party system.

Username	Phone Number	Description
`test-system-unavailable`	`(555) 555-0104`	Test the user experience during a third-party system outage.
`test-unknown-failure`	`(555) 555-0105`	Test the user experience when there is an unexpected error.
`test-session-timeout`	`(555) 555-0106`	Test the user experience when the auth session has timed out.
`test-connection-error`	`(555) 555-0107`	Test the user experience when there is a connection error caused by a network failure.
`test-high-latency`	`(555) 555-0108`	Test the flow which occurs when there is high latency communicating with backend systems.
`test-post-auth-delay`	`(555) 555-0109`	Test the flow when there is a post-auth delay happening. This may occur due to an unanticipated change in the third-party system.
`test-failure`	`(555) 555-0110`	Test a failure that occurs after a successful authentication.

Payroll system configuration

Test where the user encounters an issue with their payroll system configuration or access.

Username	Phone Number	Description
`test-distribution-not-supported`	`(555) 555-0111`	Test a user who enters an unsupported deposit amount.
`test-routing-number-not-supported`	`(555) 555-0112`	Test a user whose payroll system rejects the routing number of the target deposit account.
`test-product-not-supported`	`(555) 555-0113`	Test a user whose payroll system does not allow the operation.

User issue

Test where there is an error that occurs due to an action of the user.

Username	Phone Number	Description
`test-bad`	`(555) 555-0114`	Test an unsuccessful authentication.
`test-lockout`	`(555) 555-0115`	Test a user who has been locked out of their account.
`test-account-unusable`	`(555) 555-0116`	Test a user whose payroll account rejects the target deposit account.
`test-enrolled-in-paycard`	`(555) 555-0117`	Test a user enrolled in a paycard, which prevents payment via direct deposit.
`test-expired`	`(555) 555-0118`	Test a user whose payroll password has expired.
`test-transaction-pending`	`(555) 555-0119`	Test a user who already has a direct deposit change in progress.
`test-account-setup-incomplete`	`(555) 555-0120`	Test a user who has not fully onboarded to their employee payroll system.
`test-work-status-terminated`	`(555) 555-0121`	Test a user who is not an active employee in the payroll system.