List Statement Configurations

List Configurations

curl --request GET \
  --url https://api.treasuryprime.com/statement_config \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "account_id": "<string>",
      "apy": "<string>",
      "apy_custom": "<string>",
      "bank_disclosure_message": "<string>",
      "display_authorized_user": true,
      "email_address": "<string>",
      "footnote": "<string>",
      "id": "<string>",
      "logo_file_id": "<string>",
      "org_legal_name": "<string>",
      "phone_number": "<string>",
      "physical_address": {
        "city": "<string>",
        "postal_code": "<string>",
        "state": "<string>",
        "street_line_1": "<string>",
        "street_line_2": "<string>"
      },
      "show_transaction_ids": true,
      "support_url": "<string>",
      "timezone": "<string>"
    }
  ]
}

GET

statement_config

List Configurations

curl --request GET \
  --url https://api.treasuryprime.com/statement_config \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "account_id": "<string>",
      "apy": "<string>",
      "apy_custom": "<string>",
      "bank_disclosure_message": "<string>",
      "display_authorized_user": true,
      "email_address": "<string>",
      "footnote": "<string>",
      "id": "<string>",
      "logo_file_id": "<string>",
      "org_legal_name": "<string>",
      "phone_number": "<string>",
      "physical_address": {
        "city": "<string>",
        "postal_code": "<string>",
        "state": "<string>",
        "street_line_1": "<string>",
        "street_line_2": "<string>"
      },
      "show_transaction_ids": true,
      "support_url": "<string>",
      "timezone": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1

from_date

string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_date

string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size statement_config elements, starting after the statement_config described by page_cursor. If no more statement_configs are available, the resulting list will be empty.

data

object[]

Show child attributes

data.account_id

string

Specific Account ID to apply statement configuration; if omitted, applies to all accounts

data.apy

string

Annual Percentage Yield to be displayed on statements generated with this configuration. Must be non-negative. APY will be displayed with two-decimal precision and must be provided with two-decimal precision. The provided apy is taken as a percentage, e.g. 3.50 would indicate an APY of 3.50%Either apy or apy_custom must be populated.

data.apy_custom

string

Custom text to include on statements to describe the Annual Percentage Yield. The text provided will be displayed as right-aligned plain text above the summary on the statement. This field is intended to allow displaying tiered or other APY formats when APY is not a simple rate. When apy_custom is provided it will be used instead of an Annual Percentage Yield field in the summary. Either apy or apy_custom must be populated.

data.bank_disclosure_message

string

Bank disclosure that appears at the bottom of each statement page. Defaults to "Account offered by Member FDIC".

data.display_authorized_user

boolean

When this field is true, names of persons with the authorized_user will be displayed above the owner name in the format <name>, Representative Payee for <owner-name>. Defaults to false.

data.email_address

string

Customer support email address to appear on statements

data.footnote

string

Field to add footnote language, including Reg E Customer Complaint Information & Language. See suggested template. Whatever is entered into this field will appear as plain text at the bottom of the statement. Note, the copy included in this field is subject to approval by your partner bank.

data.id

string

Unique identifier for object

data.logo_file_id

string

ID of the File containing the logo to appear on statements. Allowed image formats are PNG, JPEG and TIFF. Image will be scaled down to fit in a 360x54 region.

data.org_legal_name

string

Legal name of your business to appear on statements

data.phone_number

string

Customer support phone number to appear on statements

data.physical_address

object

Address object representing the physical address of your business which will appear on statements

Show child attributes

data.physical_address.city

string

City

data.physical_address.postal_code

string

Postal code

data.physical_address.state

string

State

data.physical_address.street_line_1

string

First line of the address

data.physical_address.street_line_2

string

Optional second line of the address

data.show_transaction_ids

boolean

When field is true, the Treasury Prime transaction id is shown on each transaction row on the statement. Defaults to false.

data.support_url

string

Customer support website to appear on statements

data.timezone

string

Must be a valid Canonical timezone string from the tz database, this timezone is used for formatting the dates of items on the generated statement. Defaults to UTC.

List Tax Documents Create a Statement Configuration

⌘I

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Query Parameters

Response