Apiture Developers Apiture Developers

Menu

  • Explore API Banking
    • API Digital Banking
    • Embedded Banking
    • Contact Us
  • Developers
    • Quick Start Guide
    • Embedded Banking
    • Events Reference
    • Authenticated Portal
  • API Documentation
    • Reference
Log In / Register
Apiture Developers Apiture Developers
Log In / Register
Apiture Developers

Menu

  • Explore API Banking
    • API Digital Banking
    • Embedded Banking
    • Contact Us
  • Developers
    • Quick Start Guide
    • Embedded Banking
    • Events Reference
    • Authenticated Portal
  • API Documentation
    • Reference

Events

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconGuides
    • General Structure
    • Field Annotations
    • Customer Onboarding Data Direct: Real-Time
  • folder icon closed folder iconData Delivery
    • Flat File Delivery
    • Snowflake Delivery
    • Event History API
    • Real-time / Webhooks

Field Annotations

  • folder icon closed folder iconAPI Documentation
    • Getting Started
    • Concepts
      • API Keys
      • Authorization and Authentication
      • Access Tokens
      • Resources and URI Structure
      • Resource Collections
      • Resource Sets
      • Scopes & Entitlements
      • Error Responses
      • Error Types
      • Dry Runs
      • Markdown
      • Idempotent Operations
      • Collection Pagination
      • Collection Filtering
      • Transfers
      • Business Transfers
      • Cutoff Times
      • Identity Challenges
    • Guides
      • Authenticate Users in your App using OpenID Connect with PKCE
      • Authenticate using OAuth 2.0 Client Credentials Flow
      • Getting a List of Accounts
      • Listing the Balances for Accounts
      • Using Pagination
      • Creating a One-Time Transfer
      • Listing Transfers
      • Retrieving Business Transfer Information
      • Completing an Identity Challenge
    • API Reference
    • Release Notes
  • folder icon closed folder iconAuthenticated Portal
    • Getting Started
      • Registration
      • Profile
    • Concepts
      • Environments
      • Products
    • Managing your Applications
      • Creating Applications
      • Creating Data Direct: Real-Time Webhooks
      • Editing Applications
      • Application Owners
      • Getting Application Keys and IDs
      • Continue your Project
    • Release Notes
      • Developer Portal 1.0
      • Developer Portal 1.1
  • folder icon closed folder iconEmbedded Banking
    • Getting Started
    • Concepts
      • Overview
      • Managing User Credentials
      • Components
      • Registering your Application
      • Terminology
      • Encryption and Authentication
    • Guides
      • Component Customization
      • Customization Examples
      • Initializing Components
      • Event Handling and Data Processing
    • Release Notes
      • EB v1.0 Release Notes
      • EB v1.2.2 Release Notes
      • EB v1.3 Release Notes
      • Developer Portal 1.0 Update
  • folder icon closed folder iconEvents
    • Introduction
    • Guides
      • General Structure
      • Field Annotations
      • Customer Onboarding Data Direct: Real-Time
    • Data Delivery
      • Flat File Delivery
      • Snowflake Delivery
      • Event History API
      • Real-time / Webhooks

Field Annotations

Certain fields, properties or behaviors for events may require additional explanation which are noted here.

Additional Notes

Event: An action taken by a user or by the system that can be recorded. Events may include logging in, changing email addresses, and creating a new transfer.

Event Message: The record that an event occurred. The record is not available in real time. Event messages are sent to the FI and can be viewed to gain an understanding of user activity. Event messages contain both specific information about the event itself and relevant general information.

Created Events: When a resource is created, such as creating a wire transfer, an event message is generated right away. There may be additional steps needed until the resource is fully ready to be processed, such as requiring approvals.

Scheduled Transfers: An event message on a scheduled transfer does not trigger until the transfer is fully approved and ready to be executed at the arranged time. Simply creating the transfer and assigning it a time to occur does not mean it is scheduled. Transfers that do not require approvals can be scheduled as soon as a execution date is set.

User Session Duration: A user session begins when the user logs in. A user session ends when they log out, close their browser, or after a pre-determined amount of time.

sessionId and userLoggedIn: The sessionId in the event message is linked to information about a user’s session. The sessionId identifies the userLoggedIn event message created at the start of the user’s session, which includes the user’s browser and operating system. The session information stays consistent no matter which additional events may be triggered during the user’s session. After one session ends and a new session begins, event messages created during the new session have a sessionId that references a new userLoggedIn event message containing the latest session information.

How can we help?

Get support for your issues.

Explore API Banking

  • API Digital Banking
  • Embedded Banking
  • Contact Us

Developers

  • Get Started Guide
  • API Reference
  • Embedded Banking

More

  • Apiture.com

Privacy Policy

© 2023 Apiture Inc.   |   All Rights Reserved