Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
Unique identifier for object
Response
The statement_config
Specific Account ID to apply statement configuration; if omitted, applies to all accounts
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.
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.
Bank disclosure that appears at the bottom of each statementpage. Defaults to "Account offered by <bank> Member FDIC".
Customer support email address to appear on statements
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.
Unique identifier for object
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.
Legal name of your business to appear on statements
Customer support phone number to appear on statements
Address object representing the physical address of your business which will appear on statements
When field is true, the Treasury Prime transaction id is shown on each transaction row on the statement. Defaults to false
.
Customer support website to appear on statements
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
.