Generate Statement

Account ID

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 statement page. Defaults to "Account offered by <bank> Member FDIC".

Statement date in YYYY-MM format.

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.

Customer support email address to appear on statements.

Field to add footnote language, including Reg E Customer Complaint Information & Language. 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.

Interested earned on the account during the period of the statement.

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.

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

ID of a statement template to use for rendering. When provided, the template's Handlebars file is used to generate the PDF instead of the default format. Contact support to add custom templates.

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.

Type of statement. Only monthly is currently supported.

Account ID

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 statement page. Defaults to "Account offered by <bank> Member FDIC".

Statement date in YYYY-MM format.

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.

Customer support email address to appear on statements.

Field to add footnote language, including Reg E Customer Complaint Information & Language. 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.

Interested earned on the account during the period of the statement.

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.

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

ID of a statement template to use for rendering. When provided, the template's Handlebars file is used to generate the PDF instead of the default format. Contact support to add custom templates.

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.

Type of statement. Only monthly is currently supported.

URL to download the new statement