Skip to main content

Update Account Electronic Statement Preferences

Loading...
API endpoint path: /ux-users/v1/e-statements/preference

Before you call​

  • MultiStatement — This API is available only when MultiStatement is configured true for the financial institution during the onboarding process (account-level statement preference).
  • Disclosure — The preference applies only when the required e-statement disclosure agreement exists for the account in the request (for example Multi-OLS where configured). If no disclosure is available for that account, the call may fail (for example 404).
  • Access token — Obtain a V2 OAuth 2.0 access token by calling POST /oauth2/v1/token (Authentication API — Create V2 access token). Grant types, required headers (for example institutionId, transactionid), and form body are defined on that operation. Send the token in the Authorization header as Bearer <access_token>. See the Authentication API reference.

Behavior​

Updates whether account statements are delivered electronically or by mail for a single account. This preference is set per account, not for all accounts at once.

Request​

Responses​

Statement preference updated successfully