POST
/
statement_config
curl --request POST \
  --url https://api.treasuryprime.com/statement_config \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": null,
  "apy": "1.50",
  "email_address": "support@example.com",
  "footnote": "In case of errors or questions about your electronic transfers...",
  "logo_file_id": null,
  "org_legal_name": "Example Company LLC",
  "phone_number": "+1 555-1212",
  "support_url": "support.example.com"
}'
{
  "account_id": null,
  "apy": "1.50",
  "created_at": "2022-08-19T23:27:03Z",
  "email_address": "support@example.com",
  "footnote": "In case of errors or questions about your electronic transfers...",
  "id": "stmtcfg_11hg0727cpmwzt",
  "logo_file_id": null,
  "org_legal_name": "Example Company LLC",
  "phone_number": "+1 555-1212",
  "support_url": "support.example.com",
  "updated_at": "2022-08-19T23:27:03Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
The statement_config to create
​
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%

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

​
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

​
account_id
string

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

​
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 statement_config created
​
account_id
string

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

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

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

​
id
string

Unique identifier for object

​
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

Was this page helpful?