Create a Statement Configuration

Create a Configuration

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",
  "show_transaction_ids": true,
  "support_url": "support.example.com"
}
'

import requests

url = "https://api.treasuryprime.com/statement_config"

payload = {
    "account_id": None,
    "apy": "1.50",
    "email_address": "support@example.com",
    "footnote": "In case of errors or questions about your electronic transfers...",
    "logo_file_id": None,
    "org_legal_name": "Example Company LLC",
    "phone_number": "+1 555-1212",
    "show_transaction_ids": True,
    "support_url": "support.example.com"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
    show_transaction_ids: true,
    support_url: 'support.example.com'
  })
};

fetch('https://api.treasuryprime.com/statement_config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.treasuryprime.com/statement_config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
    'show_transaction_ids' => true,
    'support_url' => 'support.example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.treasuryprime.com/statement_config"

	payload := strings.NewReader("{\n  \"account_id\": null,\n  \"apy\": \"1.50\",\n  \"email_address\": \"support@example.com\",\n  \"footnote\": \"In case of errors or questions about your electronic transfers...\",\n  \"logo_file_id\": null,\n  \"org_legal_name\": \"Example Company LLC\",\n  \"phone_number\": \"+1 555-1212\",\n  \"show_transaction_ids\": true,\n  \"support_url\": \"support.example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.treasuryprime.com/statement_config")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": null,\n  \"apy\": \"1.50\",\n  \"email_address\": \"support@example.com\",\n  \"footnote\": \"In case of errors or questions about your electronic transfers...\",\n  \"logo_file_id\": null,\n  \"org_legal_name\": \"Example Company LLC\",\n  \"phone_number\": \"+1 555-1212\",\n  \"show_transaction_ids\": true,\n  \"support_url\": \"support.example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/statement_config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": null,\n  \"apy\": \"1.50\",\n  \"email_address\": \"support@example.com\",\n  \"footnote\": \"In case of errors or questions about your electronic transfers...\",\n  \"logo_file_id\": null,\n  \"org_legal_name\": \"Example Company LLC\",\n  \"phone_number\": \"+1 555-1212\",\n  \"show_transaction_ids\": true,\n  \"support_url\": \"support.example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "show_transaction_ids": true,
  "support_url": "support.example.com",
  "updated_at": "2022-08-19T23:27:03Z"
}

POST

statement_config

Create a Configuration

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",
  "show_transaction_ids": true,
  "support_url": "support.example.com"
}
'

import requests

url = "https://api.treasuryprime.com/statement_config"

payload = {
    "account_id": None,
    "apy": "1.50",
    "email_address": "support@example.com",
    "footnote": "In case of errors or questions about your electronic transfers...",
    "logo_file_id": None,
    "org_legal_name": "Example Company LLC",
    "phone_number": "+1 555-1212",
    "show_transaction_ids": True,
    "support_url": "support.example.com"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
    show_transaction_ids: true,
    support_url: 'support.example.com'
  })
};

fetch('https://api.treasuryprime.com/statement_config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.treasuryprime.com/statement_config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
    'show_transaction_ids' => true,
    'support_url' => 'support.example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.treasuryprime.com/statement_config"

	payload := strings.NewReader("{\n  \"account_id\": null,\n  \"apy\": \"1.50\",\n  \"email_address\": \"support@example.com\",\n  \"footnote\": \"In case of errors or questions about your electronic transfers...\",\n  \"logo_file_id\": null,\n  \"org_legal_name\": \"Example Company LLC\",\n  \"phone_number\": \"+1 555-1212\",\n  \"show_transaction_ids\": true,\n  \"support_url\": \"support.example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.treasuryprime.com/statement_config")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": null,\n  \"apy\": \"1.50\",\n  \"email_address\": \"support@example.com\",\n  \"footnote\": \"In case of errors or questions about your electronic transfers...\",\n  \"logo_file_id\": null,\n  \"org_legal_name\": \"Example Company LLC\",\n  \"phone_number\": \"+1 555-1212\",\n  \"show_transaction_ids\": true,\n  \"support_url\": \"support.example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/statement_config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": null,\n  \"apy\": \"1.50\",\n  \"email_address\": \"support@example.com\",\n  \"footnote\": \"In case of errors or questions about your electronic transfers...\",\n  \"logo_file_id\": null,\n  \"org_legal_name\": \"Example Company LLC\",\n  \"phone_number\": \"+1 555-1212\",\n  \"show_transaction_ids\": true,\n  \"support_url\": \"support.example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "show_transaction_ids": true,
  "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

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

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.

Pattern: ^[0-9][.][0-9][0-9]$

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.

bank_disclosure_message

string

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

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.

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

Show child attributes

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.

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.

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

Pattern: ^[0-9][.][0-9][0-9]$

apy_custom

string

bank_disclosure_message

string

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

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.

email_address

string

Customer support email address to appear on statements

footnote

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

Show child attributes

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.

support_url

string

Customer support website to appear on statements

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.

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Body

Response