E-Statements

API - V 2.5

Download Swagger Spec

Introduction

The E-Statement APIs manages the delivery preferences for statements by interacting with Users, Accounts, and Disclosures services for a given customer of a specified financial institution. The available options consist of sending the statement through email or to a physical mailing address.

Before utilizing the E-Statement APIs, the following requirements must be fulfilled:

  • MultiStatement for Online Statement is configured.
  • The customer is required to accept the terms and conditions related to enrolling in online banking and opt-in for online statements.
  • The status of the customer must be active.

What is supported?

The E-Statement APIs provide the following features:

  • View the statement preference associated with a specific account.
  • Update statement delivery preference for an individual account.
  • Update statement delivery preference for all accounts.
  • Support RETAIL and PRIMARY institution user types.

Required Roles & Permissions

To access the E-Statement APIs, the following scopes must be obtained:

Scope Purpose
accounts:readAccess to retrieve and view account details to update the delivery preferences for statements.
disclosures:readAccess to retrieve and view disclosures to verify if the user has agreed to the terms and conditions for online statements.
disclosures:writeAccess to update the current statement preference, indicating whether to receive the statement online or via postal mail.
institution-users:readAccess to retrieve and view user information to verify if the user's status is active.
close

Sign in now!

Please sign up or sign in to add to watchlist

Sign in
close

Added to watchlist!

Your interest has been noted. An NCR Voyix Rep
will contact you with further details soon.