POST
/
account
/
{account_id}
/
statement
curl --request POST \
  --url https://api.treasuryprime.com/account/{account_id}/statement \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "monthly",
  "year": "2024"
}'
{
  "account_id": "acct_2074732992",
  "date": "2024-03",
  "type": "monthly",
  "url": "https://api.treasuryprime.com/account/acct_2074732992/statement/file_11jq1f6w3h6jr"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
account_id
string
required

Account ID

Body

application/json
The account.statement.create to create
​
account_id
string
required

Account ID

​
apy
string
required

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%.

​
date
string
required

Statement date in YYYY-MM format.

​
email_address
string
required

Customer support email address to appear on statements.

​
footnote
string
required

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.

​
org_legal_name
string
required

Legal name of your business to appear on statements.

​
phone_number
string
required

Customer support phone number to appear on statements.

​
support_url
string
required

Customer support website to appear on statements.

​
type
string
required

Type of statement. Only monthly is currently supported.

​
interest_earned
string

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

​
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.

​
physical_address
object

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

Response

200 - application/json
The account.statement.create created
​
account_id
string

Account ID

​
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%.

​
date
string

Statement date in YYYY-MM format.

​
email_address
string

Customer support email address to appear on statements.

​
footnote
string

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.

​
interest_earned
string

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

​
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.

​
org_legal_name
string

Legal name of your business to appear on statements.

​
phone_number
string

Customer support phone number to appear on statements.

​
physical_address
object

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

​
support_url
string

Customer support website to appear on statements.

​
type
string

Type of statement. Only monthly is currently supported.

​
url
string

URL to download the new statement

Was this page helpful?