Account
resourcesopenapi-account.json
{
"components": {
"securitySchemes": {
"apiKey": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http"
},
"basicAuth": {
"scheme": "basic",
"type": "http"
}
}
},
"info": {
"contact": {
"email": "[email protected]",
"name": "Treasury Prime Support",
"url": "https://support.treasuryprime.com"
},
"summary": "Banking APIs",
"termsOfService": "https://www.treasuryprime.com/policy/terms",
"title": "Account",
"version": "1.16.137-gec7bd54b"
},
"openapi": "3.1.0",
"paths": {
"/account": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"account_number": "64141601",
"account_type": "checking",
"bank_id": "bank_treasuryprime",
"created_at": "2017-11-02T11:55:14Z",
"currency": "USD",
"id": "acct_1029384756",
"org_id": "org_1gwmpv3payf",
"routing_number": "021001208",
"status": "open",
"tags": null,
"updated_at": "2017-11-02T11:55:14Z",
"userdata": null
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_number": {
"description": "Bank account number. Filterable.",
"type": "string"
},
"account_type": {
"description": "One of `checking` or `savings`. Filterable.",
"type": "string"
},
"bank_id": {
"type": "string"
},
"currency": {
"description": "Three-letter ISO currency code in lowercase, indicating the currency denominating the account. Currently only `USD` is supported",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"org_id": {
"description": "ID of organization that is associated with the account. Filterable.",
"type": "string"
},
"routing_number": {
"description": "ABA routing transit number associated with the account",
"type": "string"
},
"tags": {
"description": "Array of tags associated with this account. Filterable.",
"items": {
"type": "string"
},
"type": "array"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of account.id elements"
}
},
"summary": "List Accounts",
"tags": [
"Account"
]
}
},
"/account/{account_id}/interest_rate": {
"patch": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
},
"schema": {
"properties": {
"interest_rate": {
"description": "Account interest rate",
"type": "decimal"
}
}
}
}
},
"description": "The account.interest_rate to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
},
"schema": {
"properties": {
}
}
}
},
"description": "The account.interest_rate updated"
}
},
"summary": "Set or update an account's interest rate",
"tags": [
"Account"
]
}
},
"/account/{account_id}/pending_transaction": {
"get": {
"parameters": [
{
"description": "The ID of the account to pull pending transactions for",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "The ID of the account to pull pending transactions for",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"account_id": "acct_1029384756",
"ach_id": "ach_1234567",
"amount": "1975.00",
"balance": "256147.27",
"billpay_payment_id": null,
"book_id": null,
"card_id": null,
"category": null,
"check_id": null,
"check_number": null,
"date": "2017-11-27",
"desc": "EXT-XFER Sq. Nbr.: 123456",
"extended_timestamp": "2017-11-27T01:02:03Z",
"extended_timestamp_precise": "2017-11-27T01:02:03.300Z",
"incoming_ach_id": null,
"incoming_wire_id": null,
"issued_check_id": null,
"network_transfer_id": null,
"related_transfer_ids": [],
"summary": "ACME CORP VENDOR PMT",
"trace_id": null,
"type": "deposit",
"type_source": null,
"wire_id": null
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_id": {
"description": "The ID of the account to pull pending transactions for",
"type": "string"
},
"ach_id": {
"description": "The ID of the ACH object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"amount": {
"description": "Transaction amount. Positive values indicate a credit while negative values indicate a debit. Note that transactions with type hold have an amount, but they do not change the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"balance": {
"description": "Account balance immediately after this transaction. Transactions of type hold do not affect the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"billpay_payment_id": {
"description": "The ID of the BillPay object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"book_id": {
"description": "The ID of the Book Transfer object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"card_id": {
"description": "The ID of the Card Object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"check_id": {
"description": "The ID of the Check Deposit object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"check_number": {
"description": "If this transaction is for an outbound check, the number of the check. Otherwise `null`",
"type": "string"
},
"date": {
"description": "Date of the transaction, ISO 8601 format ('YYYY-MM-DD'). Received directly from the bank, often without time zone adjustment. Might differ in date compared to `extended_timestamp` and `extended_timestamp_precise` due to timezones.",
"type": "string"
},
"desc": {
"description": "Transaction description",
"type": "string"
},
"extended_timestamp": {
"description": "Timestamp of the transaction, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC",
"type": "string"
},
"extended_timestamp_precise": {
"description": "Timestamp of the transaction, ISO 8601 format with subsecond precision ('YYYY-MM-DDThh:mm:ss.SSS[SSS]Z'). The precision could be millisecond or microsecond depending on source data. Limited availability. Always in UTC.",
"type": "string"
},
"incoming_ach_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"incoming_wire_id": {
"description": "The ID of the Incoming Wire object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"issued_check_id": {
"description": "The ID of the Issued Check Object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"network_transfer_id": {
"description": "The ID of the Network Transfer that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"related_transfer_ids": {
"description": "The IDs of the related transactions, if any. Otherwise `null`",
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"description": "Summary description of the transaction",
"type": "string"
},
"trace_id": {
"description": "A common id used to tie multiple, related transactions together. Currently used to connect `hold` and `hold_release` transactions to a `debit` and to link transactions to their related card events",
"type": "string"
},
"type": {
"description": "Type of transaction. One of `charge`, `deposit`, `hold`, `hold_release`, `interest`, `payment`, `reversal`, `withdrawal`, or `null`",
"type": "string"
},
"type_source": {
"description": "The type of payment that initiated this transaction, if any. One of `ach`, `bank`, `book`, `card`, `check`, or `wire`. Otherwise `null`. Limited availability.",
"type": "string"
},
"wire_id": {
"description": "The ID of the Wire object that originated this transaction, if any. Otherwise `null`",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of account.pending_transaction elements"
}
},
"summary": "List Pending Transactions",
"tags": [
"Account"
]
}
},
"/account/{account_id}/statement": {
"post": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"type": "monthly",
"year": "2024"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"apy": {
"description": "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%. ",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"date": {
"description": "Statement date in `YYYY-MM` format.",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements.",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"interest_earned": {
"description": "Interested earned on the account during the period of the statement.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements.",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements.",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements.",
"type": "string"
},
"type": {
"description": "Type of statement. Only `monthly` is currently supported.",
"type": "string"
}
},
"required": [
"date",
"apy",
"phone_number",
"account_id",
"type",
"footnote",
"org_legal_name",
"email_address",
"support_url"
]
}
}
},
"description": "The account.statement.create to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_2074732992",
"date": "2024-03",
"type": "monthly",
"url": "https://api.treasuryprime.com/account/acct_2074732992/statement/file_11jq1f6w3h6jr"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"apy": {
"description": "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%. ",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"date": {
"description": "Statement date in `YYYY-MM` format.",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements.",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"interest_earned": {
"description": "Interested earned on the account during the period of the statement.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements.",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements.",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements.",
"type": "string"
},
"type": {
"description": "Type of statement. Only `monthly` is currently supported.",
"type": "string"
},
"url": {
"description": "URL to download the new statement",
"type": "string"
}
}
}
}
},
"description": "The account.statement.create created"
}
},
"summary": "Generate Statement",
"tags": [
"Account Documents"
]
}
},
"/account/{account_id}/tax_document": {
"post": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"type": "1099",
"year": "2024"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"is_correction": {
"description": "Boolean indicating whether the document to be created is a correction of the existing tax document for the account",
"type": "boolean"
},
"type": {
"description": "Type of tax document. Only `1099` is currently supported",
"type": "string"
},
"year": {
"description": "Tax document year in `YYYY` format.",
"type": "string"
}
},
"required": [
"account_id",
"type",
"year",
"id"
]
}
}
},
"description": "The account.tax_document.create to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_2074732992",
"is_correction": false,
"status": "pending",
"type": "1099",
"year": "2024"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"id": {
"description": "Tax Document ID",
"type": "string"
},
"is_correction": {
"description": "Boolean indicating whether the document to be created is a correction of the existing tax document for the account",
"type": "boolean"
},
"status": {
"description": "Status of the tax document",
"type": "string"
},
"type": {
"description": "Type of tax document. Only `1099` is currently supported",
"type": "string"
},
"year": {
"description": "Tax document year in `YYYY` format.",
"type": "string"
}
}
}
}
},
"description": "The account.tax_document.create created"
}
},
"summary": "Generate Tax Document",
"tags": [
"Account Documents"
]
}
},
"/account/{account_id}/tax_document/{id}": {
"delete": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
},
{
"description": "Tax Document ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Tax Document ID",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
}
}
}
}
},
"description": "The account.tax_document.delete to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_2074732992",
"is_correction": false,
"status": "deleted",
"type": "1099",
"year": "2024"
}
}
},
"schema": {
"properties": {
}
}
}
},
"description": "The account.tax_document.delete updated"
}
},
"summary": "Delete Tax Document",
"tags": [
"Account Documents"
]
},
"get": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
},
{
"description": "Tax document ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Tax document ID",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_2074732992",
"is_correction": false,
"status": "pending",
"type": "1099",
"url": "https://api.treasuryprime.com/account/acct_2074732992/statement/file_11khr0vt3vrgb",
"year": "2024"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"id": {
"description": "Tax document ID",
"type": "string"
},
"is_correction": {
"type": "boolean"
},
"status": {
"description": "Status of the statement",
"type": "string"
},
"type": {
"description": "Type of statement. One of: `1099`",
"type": "string"
},
"url": {
"description": "URL to download the new statement",
"type": "string"
},
"year": {
"description": "Statement year in `YYYY` format",
"type": "string"
}
}
}
}
},
"description": "The account.tax_document"
}
},
"summary": "Get Tax Document",
"tags": [
"Account Documents"
]
},
"patch": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
},
{
"description": "Tax Document ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Tax Document ID",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"id": "taxdoc_abc456",
"status": "filed"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"status": {
"description": "Status of the tax document",
"type": "string"
}
}
}
}
},
"description": "The account.tax_document.update to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_2074732992",
"is_correction": false,
"status": "pending",
"type": "1099",
"year": "2024"
}
}
},
"schema": {
"properties": {
}
}
}
},
"description": "The account.tax_document.update updated"
}
},
"summary": "File Tax Document",
"tags": [
"Account Documents"
]
}
},
"/account/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_number": "64141601",
"account_type": "checking",
"address": {
"city": "San Francisco",
"postal_code": "94104",
"state": "CA",
"street_line_1": "1 Market St",
"street_line_2": "Suite 42"
},
"available_balance": "86753.09",
"bank_id": "bank_treasuryprime",
"business_ids": [],
"created_at": "2017-11-02T11:55:14Z",
"currency": "USD",
"current_balance": "86753.09",
"funded": true,
"id": "acct_1029384756",
"lock": null,
"locked": false,
"name": "George Washington",
"org_id": "org_1gwmpv3payf",
"person_ids": [
"owner_01d6y044p21s"
],
"primary_person_id": "owner_01d6y044p21s",
"routing_number": "021001208",
"status": "open",
"tags": null,
"updated_at": "2017-11-02T11:55:14Z",
"userdata": null
}
}
},
"schema": {
"properties": {
"account_number": {
"description": "Bank account number. Filterable.",
"type": "string"
},
"account_product_id": {
"description": "Account Product used to create the account",
"type": "string"
},
"account_type": {
"description": "One of `checking` or `savings`",
"type": "string"
},
"additional_account_numbers": {
"description": "Invoice account numbers associated with the account",
"items": {
"type": "string"
},
"type": "array"
},
"address": {
"deprecated": true,
"description": "Address associated with the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"available_balance": {
"description": "Available funds in this account. If not available, the value will be `null`",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bank_id": {
"description": "ID of the bank with which the account is associated",
"type": "string"
},
"business_ids": {
"description": "Array of IDs of Business objects representing all businesses that own this account. Always empty for personal accounts",
"items": {
"type": "string"
},
"type": "array"
},
"currency": {
"description": "Three-letter ISO currency code in lowercase, indicating the currency denominating the account. Currently only `USD` is supported",
"type": "string"
},
"current_balance": {
"description": "Last known account balance, with two-decimal precision. Note that some accounts may not support this field; if not available, the value will be `null`",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"funded": {
"description": "`true` if the account has ever been funded with an amount greater than $0, `false` otherwise",
"type": "boolean"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"interest_rate": {
"description": "Interest rate for the account",
"type": "decimal"
},
"lock": {
"description": "Details related to account lock (returned only when `locked` is `true`).",
"properties": {
"additional_context": {
"description": "Optional text to include additional details for the reason to lock the account. It is recommend to include the payment ID such as the ACH id that is under investigation or the application ID for the customer. This additional context will be provided to your bank.",
"type": "string"
},
"reason": {
"description": "Reason for locking account. One of \n`transactions_being_investigated_wire`, \n`transactions_being_investigated_card`, \n`transactions_being_investigated_ACH`, \n`transactions_being_investigated_check_issued`, \n`transactions_being_investigated_check_deposit`, \n`identity_of_customer_being_investigated`.\n\nWhen unlocking an account, a reason is not required.",
"type": "string"
}
},
"type": "object"
},
"locked": {
"description": "`true` if the account is in a locked state, `false` otherwise",
"type": "boolean"
},
"mailing_address": {
"description": "Mailing address associated with the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"name": {
"deprecated": true,
"description": "Name of the person or company that owns the bank account",
"type": "string"
},
"org_id": {
"description": "ID of the organization with which the account is associated. Filterable.",
"type": "string"
},
"person_ids": {
"description": "Array of IDs of Person objects representing all people who own this account",
"items": {
"type": "string"
},
"type": "array"
},
"physical_address": {
"description": "Physical address associated with the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"primary_person_id": {
"description": "ID of the Person indicating the primary account holder",
"type": "string"
},
"routing_number": {
"description": "ABA routing transit number associated with the account",
"type": "string"
},
"status": {
"description": "The status of the account. One of `open`, `closed`, or `close_pending`",
"type": "string"
},
"tags": {
"description": "Array of tags associated with this account. Filterable.",
"items": {
"type": "string"
},
"type": "array"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The account"
}
},
"summary": "Fetch an Account",
"tags": [
"Account"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Locking an account",
"value": {
"lock": {
"additional_context": "ach_123453254 is disputed by customer.",
"reason": "transactions_being_investigated_ACH"
},
"locked": true
}
},
"unlock": {
"summary": "Unlocking an account",
"value": {
"locked": false
}
}
},
"schema": {
"properties": {
"lock": {
"description": "Object containing details pertaining to placing a lock on an account",
"properties": {
"additional_context": {
"description": "Optional text to include additional details for the reason to lock the account. It is recommend to include the payment ID such as the ACH id that is under investigation or the application ID for the customer. This additional context will be provided to your bank.",
"type": "string"
},
"reason": {
"description": "Reason for locking account. One of \n`transactions_being_investigated_wire`, \n`transactions_being_investigated_card`, \n`transactions_being_investigated_ACH`, \n`transactions_being_investigated_check_issued`, \n`transactions_being_investigated_check_deposit`, \n`identity_of_customer_being_investigated`.\n\nWhen unlocking an account, a reason is not required.",
"type": "string"
}
},
"type": "object"
},
"locked": {
"description": "`true` if the account should be locked",
"type": "boolean"
},
"mailing_address": {
"description": "Mailing address of the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"physical_address": {
"description": "Physical address of the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "Updated status of the account. One of: `close_pending`. Cannot be passed with `locked` set to `true`",
"type": "string"
},
"tags": {
"description": "Array of tags associated with this account. Filterable.",
"items": {
"type": "string"
},
"type": "array"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The account to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_number": "64141601",
"account_type": "checking",
"address": {
"city": "San Francisco",
"postal_code": "94104",
"state": "CA",
"street_line_1": "1 Market St",
"street_line_2": "Suite 42"
},
"available_balance": "86753.09",
"bank_id": "bank_treasuryprime",
"business_ids": [],
"created_at": "2017-11-02T11:55:14Z",
"currency": "USD",
"current_balance": "86753.09",
"funded": true,
"id": "acct_1029384756",
"lock": {
"additional_context": "ach_123453254 is disputed by customer.",
"reason": "transactions_being_investigated_ACH"
},
"locked": true,
"name": "George Washington",
"org_id": "org_1gwmpv3payf",
"person_ids": [
"owner_01d6y044p21s"
],
"primary_person_id": "owner_01d6y044p21s",
"routing_number": "021001208",
"status": "open",
"tags": null,
"updated_at": "2017-11-02T11:55:14Z",
"userdata": null
}
}
},
"schema": {
"properties": {
"account_number": {
"description": "Bank account number. Filterable.",
"type": "string"
},
"account_product_id": {
"description": "Account Product used to create the account",
"type": "string"
},
"account_type": {
"description": "One of `checking` or `savings`",
"type": "string"
},
"additional_account_numbers": {
"description": "Invoice account numbers associated with the account",
"items": {
"type": "string"
},
"type": "array"
},
"address": {
"deprecated": true,
"description": "Address associated with the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"available_balance": {
"description": "Available funds in this account. If not available, the value will be `null`",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bank_id": {
"description": "ID of the bank with which the account is associated",
"type": "string"
},
"business_ids": {
"description": "Array of IDs of Business objects representing all businesses that own this account. Always empty for personal accounts",
"items": {
"type": "string"
},
"type": "array"
},
"currency": {
"description": "Three-letter ISO currency code in lowercase, indicating the currency denominating the account. Currently only `USD` is supported",
"type": "string"
},
"current_balance": {
"description": "Last known account balance, with two-decimal precision. Note that some accounts may not support this field; if not available, the value will be `null`",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"funded": {
"description": "`true` if the account has ever been funded with an amount greater than $0, `false` otherwise",
"type": "boolean"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"interest_rate": {
"description": "Interest rate for the account",
"type": "decimal"
},
"lock": {
"description": "Details related to account lock (returned only when `locked` is `true`).",
"properties": {
"additional_context": {
"description": "Optional text to include additional details for the reason to lock the account. It is recommend to include the payment ID such as the ACH id that is under investigation or the application ID for the customer. This additional context will be provided to your bank.",
"type": "string"
},
"reason": {
"description": "Reason for locking account. One of \n`transactions_being_investigated_wire`, \n`transactions_being_investigated_card`, \n`transactions_being_investigated_ACH`, \n`transactions_being_investigated_check_issued`, \n`transactions_being_investigated_check_deposit`, \n`identity_of_customer_being_investigated`.\n\nWhen unlocking an account, a reason is not required.",
"type": "string"
}
},
"type": "object"
},
"locked": {
"description": "`true` if the account is in a locked state, `false` otherwise",
"type": "boolean"
},
"mailing_address": {
"description": "Mailing address associated with the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"name": {
"deprecated": true,
"description": "Name of the person or company that owns the bank account",
"type": "string"
},
"org_id": {
"description": "ID of the organization with which the account is associated. Filterable.",
"type": "string"
},
"person_ids": {
"description": "Array of IDs of Person objects representing all people who own this account",
"items": {
"type": "string"
},
"type": "array"
},
"physical_address": {
"description": "Physical address associated with the account",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"primary_person_id": {
"description": "ID of the Person indicating the primary account holder",
"type": "string"
},
"routing_number": {
"description": "ABA routing transit number associated with the account",
"type": "string"
},
"status": {
"description": "The status of the account. One of `open`, `closed`, or `close_pending`",
"type": "string"
},
"tags": {
"description": "Array of tags associated with this account. Filterable.",
"items": {
"type": "string"
},
"type": "array"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The account updated"
}
},
"summary": "Update an Account",
"tags": [
"Account"
]
}
},
"/account/{id}/average_balance": {
"get": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"average_balance": "253361.00",
"month": "2024-05"
},
{
"average_balance": "255281.00",
"month": "2024-04"
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"average_balance": {
"description": "Average account balance for the month",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"month": {
"description": "Month for this average, ISO 8601 format ('YYYY-MM')",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of account.average_balance elements"
}
},
"summary": "List Average Balances",
"tags": [
"Account"
]
}
},
"/account/{id}/daily_balance": {
"get": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"balance": "255281.00",
"current_balance": "",
"date": "2024-02-01"
},
{
"balance": "253361.00",
"current_balance": "",
"date": "2022-02-02"
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"balance": {
"description": "Last balance of the day",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"current_balance": {
"description": "Last current balance of the day",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"date": {
"description": "Date for this balance, ISO 8601 format ('YYYY-MM-DD')",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of account.daily_balance elements"
}
},
"summary": "List Daily Balances",
"tags": [
"Account"
]
}
},
"/account/{id}/statement": {
"get": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"1099": {
"summary": "1099-INT Statement",
"value": {
"type": "1099",
"url": "https://api.treasuryprime.com/account/acct_2074732992/statement/file_11jq1f6w3h58v",
"year": "2020"
}
},
"monthly": {
"summary": "Monthly Statement",
"value": {
"date": "2018-12",
"type": "monthly",
"url": "https://api.treasuryprime.com/account/acct_1029384756/statement/monthly.ND000123456789.201812.pdf"
}
}
},
"schema": {
"properties": {
"date": {
"description": "Statement date in `YYYY-MM` format. Required when `type` is `monthly`.",
"type": "string"
},
"id": {
"description": "Account ID",
"type": "string"
},
"type": {
"description": "Type of statement. One of: `monthly`, `1099`",
"type": "string"
},
"url": {
"description": "URL to download the statement",
"type": "string"
},
"year": {
"description": "Statement year in `YYYY` format. Required when `type` is `1099`.",
"type": "string"
}
}
}
}
},
"description": "The account.statement"
}
},
"summary": "Fetch a Statement",
"tags": [
"Account Documents"
]
}
},
"/account/{id}/tax_document": {
"get": {
"parameters": [
{
"description": "Account ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Account ID",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Account ID",
"type": "string"
},
"type": {
"description": "Type of statement. One of: `1099`. Filterable.",
"type": "string"
},
"year": {
"description": "Statement year in `YYYY` format. Filterable.",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of account.tax_document.index elements"
}
},
"summary": "List of tax documents",
"tags": [
"Account Documents"
]
}
},
"/account/{id}/transaction": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"ach_id": "ach_1234567",
"amount": "1975.00",
"balance": "256147.27",
"billpay_payment_id": null,
"book_id": null,
"card_id": null,
"category": null,
"check_id": null,
"check_number": null,
"date": "2017-11-27",
"desc": "EXT-XFER Sq. Nbr.: 123456",
"extended_timestamp": "2017-11-27T01:02:03Z",
"extended_timestamp_precise": "2017-11-27T01:02:03.300Z",
"fingerprint": "2k7vxetham4i1v3ceb5vs6",
"id": "ttx_113333abcd",
"incoming_ach_id": null,
"incoming_wire": null,
"incoming_wire_id": null,
"issued_check_id": null,
"network_transfer_id": null,
"related_transfer_ids": [],
"summary": "ACME CORP VENDOR PMT",
"trace_id": null,
"type": "deposit",
"type_source": null,
"userdata": null,
"wire": null,
"wire_id": null
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"ach_id": {
"description": "The ID of the ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"amount": {
"description": "Transaction amount. Positive values indicate a credit while negative values indicate a debit. Note that transactions with type hold have an amount, but they do not change the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"balance": {
"description": "Account balance immediately after this transaction. Transactions of type hold do not affect the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"billpay_payment_id": {
"description": "The ID of the BillPay object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"book_id": {
"description": "The ID of the Book Transfer object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"card_id": {
"description": "The ID of the Card Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"category": {
"description": "One of: `interest`, `fees`, or `null`. Update this field to indicate if the transaction is an interest or fee payment",
"type": "string"
},
"check_id": {
"description": "The ID of the Check Deposit object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"check_number": {
"description": "If this transaction is for an outbound check, the number of the check. Otherwise `null`",
"type": "string"
},
"date": {
"description": "Date of the transaction, ISO 8601 format ('YYYY-MM-DD'). Received directly from the bank, often without time zone adjustment. Might differ in date compared to `extended_timestamp` and `extended_timestamp_precise` due to timezones.",
"type": "string"
},
"desc": {
"description": "Transaction description",
"type": "string"
},
"extended_timestamp": {
"description": "Timestamp of the transaction, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC",
"type": "string"
},
"extended_timestamp_precise": {
"description": "Timestamp of the transaction, ISO 8601 format with subsecond precision ('YYYY-MM-DDThh:mm:ss.SSS[SSS]Z'). The precision could be millisecond or microsecond depending on source data. Limited availability. Always in UTC.",
"type": "string"
},
"fingerprint": {
"description": "A unique fingerprint for this transaction",
"type": "string"
},
"human_readable_description": {
"description": "A user-friendly description. Note, there may be a short period (less than 60 seconds) after a transaction is accessible through our API where this field is not yet populated.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"incoming_ach_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"incoming_wire": {
"deprecated": true,
"description": "Data related to the wire that originated this transaction, if any. Otherwise `null`",
"type": "object"
},
"incoming_wire_id": {
"description": "The ID of the Incoming Wire object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"issued_check_id": {
"description": "The ID of the Issued Check Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"network_transfer_id": {
"description": "The ID of the Network Transfer that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"related_transfer_ids": {
"description": "The IDs of the related transactions, if any. Otherwise `null`",
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"description": "Summary description of the transaction",
"type": "string"
},
"trace_id": {
"description": "A common id used to tie multiple, related transactions together. Currently used to connect `hold` and `hold_release` transactions to a `debit` and to link transactions to their related card events. Filterable.",
"type": "string"
},
"type": {
"description": "Type of transaction. One of `charge`, `deposit`, `hold`, `hold_release`, `interest`, `payment`, `reversal`, `withdrawal`, or `null`. Filterable.",
"type": "string"
},
"type_source": {
"description": "The type of payment that initiated this transaction, if any. One of `ach`, `bank`, `book`, `card`, `check`, or `wire`. Otherwise `null`. Limited availability.",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
},
"wire": {
"description": "For wire transactions, the Fedwire description, if any. Otherwise `null`.",
"type": "string"
},
"wire_id": {
"description": "The ID of the Wire object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of account.transaction elements"
}
},
"summary": "List Transactions",
"tags": [
"Account"
]
}
},
"/account_lock": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"account_id": "acct_1234567890",
"additional_context": "ach_123453254 is disputed by customer.",
"bank_id": "bank_treasuryprime",
"id": "lock_1234567890",
"locked": false,
"org_id": "org_1234567890",
"reason": "transactions_being_investigated_ACH",
"released_at": "2024-04-02T11:55:14Z"
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_id": {
"description": "ID of account that is associated with the account lock. Filterable.",
"type": "string"
},
"additional_context": {
"description": "Additional context about the lock",
"type": "string"
},
"bank_id": {
"description": "ID of bank that is associated with the account lock. Filterable.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"locked": {
"description": "`true` if the account lock is active. Filterable.",
"enum": [
"true",
"false"
],
"type": "string"
},
"org_id": {
"description": "ID of organization that is associated with the account lock. Filterable.",
"type": "string"
},
"reason": {
"description": "Reason for locking account. One of \n`transactions_being_investigated_wire`, \n`transactions_being_investigated_card`, \n`transactions_being_investigated_ACH`, \n`transactions_being_investigated_check_issued`, \n`transactions_being_investigated_check_deposit`, \n`identity_of_customer_being_investigated`.",
"type": "string"
},
"released_at": {
"description": "Timestamp of when the account lock was released",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of lock elements"
}
},
"summary": "List Account Locks",
"tags": [
"Account"
]
}
},
"/account_lock/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_1234567890",
"additional_context": "ach_123453254 is disputed by customer.",
"bank_id": "bank_treasuryprime",
"id": "lock_1234567890",
"locked": false,
"org_id": "org_1234567890",
"reason": "transactions_being_investigated_ACH",
"released_at": "2024-04-02T11:55:14Z"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of account that is associated with the account lock. Filterable.",
"type": "string"
},
"additional_context": {
"description": "Additional context about the lock",
"type": "string"
},
"bank_id": {
"description": "ID of bank that is associated with the account lock. Filterable.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"locked": {
"description": "`true` if the account lock is active. Filterable.",
"enum": [
"true",
"false"
],
"type": "string"
},
"org_id": {
"description": "ID of organization that is associated with the account lock. Filterable.",
"type": "string"
},
"reason": {
"description": "Reason for locking account. One of \n`transactions_being_investigated_wire`, \n`transactions_being_investigated_card`, \n`transactions_being_investigated_ACH`, \n`transactions_being_investigated_check_issued`, \n`transactions_being_investigated_check_deposit`, \n`identity_of_customer_being_investigated`.",
"type": "string"
},
"released_at": {
"description": "Timestamp of when the account lock was released",
"type": "string"
}
}
}
}
},
"description": "The lock"
}
},
"summary": "Fetch an Account Lock",
"tags": [
"Account"
]
}
},
"/business/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_ids": [
"acct_1029384756"
],
"address": {
"city": "New York",
"postal_code": "10005",
"state": "NY",
"street_line_1": "11 Wall St",
"street_line_2": "Suite 42"
},
"emails": [
"[email protected]"
],
"id": "owner_0123456789",
"name": "Acme Goods Inc",
"phone_number": "4154845555",
"tin_last4": "4912"
}
}
},
"schema": {
"properties": {
"account_ids": {
"description": "Array of IDs of Account objects representing all accounts attached to this business",
"items": {
"type": "string"
},
"type": "array"
},
"address": {
"description": "Address on file associated with the business",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"bankdata": {
"description": "Optional bank data associated with the business",
"type": "object"
},
"emails": {
"description": "Email addresses of the business",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"name": {
"description": "Name of the business",
"type": "string"
},
"phone_number": {
"description": "Phone number of the business",
"type": "string"
},
"tin_last4": {
"description": "The last four digits of the TIN / EIN",
"type": "string"
}
}
}
}
},
"description": "The business"
}
},
"summary": "Fetch a Business",
"tags": [
"Business"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Update address",
"value": {
"address": {
"city": "New York",
"postal_code": "10005",
"state": "NY",
"street_line_1": "11 Wall St",
"street_line_2": "Suite 42"
}
}
}
},
"schema": {
"properties": {
"address": {
"description": "Address on file associated with the business",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"description": "The business to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_ids": [
"acct_1029384756"
],
"address": {
"city": "New York",
"postal_code": "10005",
"state": "NY",
"street_line_1": "11 Wall St",
"street_line_2": "Suite 42"
},
"emails": [
"[email protected]"
],
"id": "owner_0123456789",
"name": "Acme Goods Inc",
"phone_number": "4154845555",
"tin_last4": "4912"
}
}
},
"schema": {
"properties": {
"account_ids": {
"description": "Array of IDs of Account objects representing all accounts attached to this business",
"items": {
"type": "string"
},
"type": "array"
},
"address": {
"description": "Address on file associated with the business",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"bankdata": {
"description": "Optional bank data associated with the business",
"type": "object"
},
"emails": {
"description": "Email addresses of the business",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"name": {
"description": "Name of the business",
"type": "string"
},
"phone_number": {
"description": "Phone number of the business",
"type": "string"
},
"tin_last4": {
"description": "The last four digits of the TIN / EIN",
"type": "string"
}
}
}
}
},
"description": "The business updated"
}
},
"summary": "Update a Business",
"tags": [
"Business"
]
}
},
"/deposit_sweep": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"account_id": "acct_abc123456",
"bank_id": "bank_example",
"created_at": "2023-04-27T15:26:58Z",
"id": "dsa_abc654321",
"network": "network-name",
"network_account_id": "abc123456",
"opted_in": true,
"sweep_balance": "2500.00",
"threshold_balance": "125000.00",
"updated_at": "2023-06-29T13:58:20Z"
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_id": {
"description": "ID of the Account associated with the Deposit Sweep object",
"type": "string"
},
"bank_id": {
"description": "ID of the bank for the deposit sweep account",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"network": {
"description": "Name of the deposit sweep network associated with the object",
"type": "string"
},
"network_account_id": {
"description": "Identifier used with the network for the deposit sweep account",
"type": "string"
},
"opted_in": {
"description": "Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program",
"type": "boolean"
},
"sweep_balance": {
"description": "Current sweep balance reported to the deposit sweep network, with two decimal precision. This will be null when the account has not been reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"threshold_balance": {
"description": "Threshold balance over which funds should be reported to the deposit sweep network, with two decimal precision. Example: If the `current_balance` of an account was $20 and the `threshold_balance` was $15, a sweep balance of $5 would be reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of deposit_sweep elements"
}
},
"summary": "List Deposit Sweeps",
"tags": [
"Enhanced FDIC Insurance"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_11hryybpgdc399",
"network": "network-name",
"opted_in": true,
"threshold_balance": "250000.00"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the Account associated with the Deposit Sweep object",
"type": "string"
},
"network": {
"description": "Name of the deposit sweep network associated with the object",
"type": "string"
},
"opted_in": {
"description": "Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program",
"type": "boolean"
},
"threshold_balance": {
"description": "Threshold balance over which funds should be reported to the deposit sweep network, with two decimal precision. Example: If the `current_balance` of an account was $20 and the `threshold_balance` was $15, a sweep balance of $5 would be reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
}
},
"required": [
"account_id",
"opted_in",
"threshold_balance",
"id",
"network"
]
}
}
},
"description": "The deposit_sweep to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_abc123456",
"bank_id": "bank_example",
"created_at": "2023-04-27T15:26:58Z",
"id": "dsa_abc654321",
"network": "network-name",
"network_account_id": "abc123456",
"opted_in": true,
"sweep_balance": "2500.00",
"threshold_balance": "125000.00",
"updated_at": "2023-06-29T13:58:20Z"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the Account associated with the Deposit Sweep object",
"type": "string"
},
"bank_id": {
"description": "ID of the bank for the deposit sweep account",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"network": {
"description": "Name of the deposit sweep network associated with the object",
"type": "string"
},
"network_account_id": {
"description": "Identifier used with the network for the deposit sweep account",
"type": "string"
},
"opted_in": {
"description": "Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program",
"type": "boolean"
},
"sweep_balance": {
"description": "Current sweep balance reported to the deposit sweep network, with two decimal precision. This will be null when the account has not been reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"threshold_balance": {
"description": "Threshold balance over which funds should be reported to the deposit sweep network, with two decimal precision. Example: If the `current_balance` of an account was $20 and the `threshold_balance` was $15, a sweep balance of $5 would be reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
}
}
}
}
},
"description": "The deposit_sweep created"
}
},
"summary": "Create a Deposit Sweep",
"tags": [
"Enhanced FDIC Insurance"
]
}
},
"/deposit_sweep/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_abc123456",
"bank_id": "bank_example",
"created_at": "2023-04-27T15:26:58Z",
"id": "dsa_abc654321",
"network": "network-name",
"network_account_id": "abc123456",
"opted_in": true,
"sweep_balance": "2500.00",
"threshold_balance": "125000.00",
"updated_at": "2023-06-29T13:58:20Z"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the Account associated with the Deposit Sweep object",
"type": "string"
},
"bank_id": {
"description": "ID of the bank for the deposit sweep account",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"network": {
"description": "Name of the deposit sweep network associated with the object",
"type": "string"
},
"network_account_id": {
"description": "Identifier used with the network for the deposit sweep account",
"type": "string"
},
"opted_in": {
"description": "Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program",
"type": "boolean"
},
"sweep_balance": {
"description": "Current sweep balance reported to the deposit sweep network, with two decimal precision. This will be null when the account has not been reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"threshold_balance": {
"description": "Threshold balance over which funds should be reported to the deposit sweep network, with two decimal precision. Example: If the `current_balance` of an account was $20 and the `threshold_balance` was $15, a sweep balance of $5 would be reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
}
}
}
}
},
"description": "The deposit_sweep"
}
},
"summary": "Fetch a Deposit Sweep",
"tags": [
"Enhanced FDIC Insurance"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Updating threshold balance",
"value": {
"threshold_balance": "125000.00"
}
}
},
"schema": {
"properties": {
"opted_in": {
"description": "Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program",
"type": "boolean"
},
"threshold_balance": {
"description": "Threshold balance over which funds should be reported to the deposit sweep network, with two decimal precision. Example: If the `current_balance` of an account was $20 and the `threshold_balance` was $15, a sweep balance of $5 would be reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
}
}
}
}
},
"description": "The deposit_sweep to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_abc123456",
"bank_id": "bank_example",
"created_at": "2023-04-27T15:26:58Z",
"id": "dsa_abc654321",
"network": "network-name",
"network_account_id": "abc123456",
"opted_in": true,
"sweep_balance": "2500.00",
"threshold_balance": "125000.00",
"updated_at": "2023-06-29T13:58:20Z"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the Account associated with the Deposit Sweep object",
"type": "string"
},
"bank_id": {
"description": "ID of the bank for the deposit sweep account",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"network": {
"description": "Name of the deposit sweep network associated with the object",
"type": "string"
},
"network_account_id": {
"description": "Identifier used with the network for the deposit sweep account",
"type": "string"
},
"opted_in": {
"description": "Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program",
"type": "boolean"
},
"sweep_balance": {
"description": "Current sweep balance reported to the deposit sweep network, with two decimal precision. This will be null when the account has not been reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"threshold_balance": {
"description": "Threshold balance over which funds should be reported to the deposit sweep network, with two decimal precision. Example: If the `current_balance` of an account was $20 and the `threshold_balance` was $15, a sweep balance of $5 would be reported to the network.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
}
}
}
}
},
"description": "The deposit_sweep updated"
}
},
"summary": "Update a Deposit Sweep",
"tags": [
"Enhanced FDIC Insurance"
]
}
},
"/person/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_ids": [
"acct_1029384756"
],
"address": {
"city": "San Francisco",
"postal_code": "94104",
"state": "CA",
"street_line_1": "1 Market St",
"street_line_2": "Suite 42"
},
"email": "[email protected]",
"first_name": "George",
"id": "owner_9876543210",
"last_name": "Washington",
"middle_name": null,
"phone_number": "4154845555",
"suffix": null,
"tin_last4": "3192"
}
}
},
"schema": {
"properties": {
"account_ids": {
"description": "Account IDs associated with the Person",
"items": {
"type": "string"
},
"type": "array"
},
"address": {
"deprecated": true,
"description": "Address associated with the Person",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"bankdata": {
"description": "Optional bank data associated with the person",
"type": "object"
},
"email": {
"description": "Email address",
"type": "string"
},
"first_name": {
"description": "Given name of person",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"last_name": {
"description": "Family name of person",
"type": "string"
},
"mailing_address": {
"description": "The address where the person can receive mail. This is where physical cards will be sent when issued. If this field is `null`, `physical_address` will be used instead.",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"middle_name": {
"description": "Middle name of person",
"type": "string"
},
"phone_number": {
"description": "The person's phone number. When necessary, this number will be used for calls or texts related to card activation.",
"type": "string"
},
"physical_address": {
"description": "The address of person's physical location",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"suffix": {
"description": "The person's suffix (e.g. 'Jr.', 'Sr.', 'III'), if applicable",
"type": "string"
},
"tin_last4": {
"description": "Last 4 digits of the person's tax ID (SSN), if available",
"type": "string"
},
"userdata": {
"description": "Optional user data associated with the person",
"type": "object"
}
}
}
}
},
"description": "The person"
}
},
"summary": "Fetch a Person",
"tags": [
"Person"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Update address",
"value": {
"mailing_address": {
"city": "Seattle",
"postal_code": "98102",
"state": "WA",
"street_line_1": "888 Rainy Lane",
"street_line_2": null
}
}
}
},
"schema": {
"properties": {
"address": {
"deprecated": true,
"description": "Address associated with the Person",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"email": {
"description": "Email address",
"type": "string"
},
"mailing_address": {
"description": "The address where the person can receive mail. This is where physical cards will be sent when issued. If this field is `null`, `physical_address` will be used instead.",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"phone_number": {
"description": "The person's phone number. When necessary, this number will be used for calls or texts related to card activation.",
"type": "string"
},
"physical_address": {
"description": "The address of person's physical location",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"userdata": {
"description": "Optional user data associated with the person",
"type": "object"
}
}
}
}
},
"description": "The person to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_ids": [
"acct_1029384756"
],
"address": {
"city": "San Francisco",
"postal_code": "94104",
"state": "CA",
"street_line_1": "1 Market St",
"street_line_2": "Suite 42"
},
"email": "[email protected]",
"first_name": "George",
"id": "owner_9876543210",
"last_name": "Washington",
"mailing_address": {
"city": "Seattle",
"postal_code": "98102",
"state": "WA",
"street_line_1": "888 Rainy Lane",
"street_line_2": null
},
"middle_name": null,
"phone_number": "4154845555",
"suffix": null,
"tin_last4": "3192"
}
}
},
"schema": {
"properties": {
"account_ids": {
"description": "Account IDs associated with the Person",
"items": {
"type": "string"
},
"type": "array"
},
"address": {
"deprecated": true,
"description": "Address associated with the Person",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"bankdata": {
"description": "Optional bank data associated with the person",
"type": "object"
},
"email": {
"description": "Email address",
"type": "string"
},
"first_name": {
"description": "Given name of person",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"last_name": {
"description": "Family name of person",
"type": "string"
},
"mailing_address": {
"description": "The address where the person can receive mail. This is where physical cards will be sent when issued. If this field is `null`, `physical_address` will be used instead.",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"middle_name": {
"description": "Middle name of person",
"type": "string"
},
"phone_number": {
"description": "The person's phone number. When necessary, this number will be used for calls or texts related to card activation.",
"type": "string"
},
"physical_address": {
"description": "The address of person's physical location",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"country": {
"description": "Country (ISO 3166-1 alpha-2). Defaults to `US`",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"suffix": {
"description": "The person's suffix (e.g. 'Jr.', 'Sr.', 'III'), if applicable",
"type": "string"
},
"tin_last4": {
"description": "Last 4 digits of the person's tax ID (SSN), if available",
"type": "string"
},
"userdata": {
"description": "Optional user data associated with the person",
"type": "object"
}
}
}
}
},
"description": "The person updated"
}
},
"summary": "Update a Person",
"tags": [
"Person"
]
}
},
"/reserve": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"account_id": "acct_1234567890",
"amount": "0.00",
"id": "reserve_1029384756",
"reserve_account_id": "acct_0987654321",
"upper_limit": "100.00",
"userdata": null
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_id": {
"description": "ID of the target Account that has an added reserve limit. Filterable.",
"type": "string"
},
"amount": {
"description": "Amount that `account_id` is currently overdrawn",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bankdata": {
"description": "Optional data for the bank",
"type": "object"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"reserve_account_id": {
"description": "ID of the Account that holds the reserve. Filterable.",
"type": "string"
},
"upper_limit": {
"description": "Max amount that `account_id` may be overdrawn in total",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of reserve elements"
}
},
"summary": "List Reserve Accounts",
"tags": [
"Reserve Account"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_1234567890",
"reserve_account_id": "acct_0987654321",
"upper_limit": "100.00"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the target Account that has an added reserve limit. Filterable.",
"type": "string"
},
"amount": {
"description": "Amount that `account_id` is currently overdrawn",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bankdata": {
"description": "Optional data for the bank",
"type": "object"
},
"reserve_account_id": {
"description": "ID of the Account that holds the reserve. Filterable.",
"type": "string"
},
"upper_limit": {
"description": "Max amount that `account_id` may be overdrawn in total",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
},
"required": [
"amount",
"account_id",
"reserve_account_id",
"id",
"upper_limit"
]
}
}
},
"description": "The reserve to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_1234567890",
"amount": "0.00",
"id": "reserve_1029384756",
"reserve_account_id": "acct_0987654321",
"upper_limit": "100.00",
"userdata": null
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the target Account that has an added reserve limit. Filterable.",
"type": "string"
},
"amount": {
"description": "Amount that `account_id` is currently overdrawn",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bankdata": {
"description": "Optional data for the bank",
"type": "object"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"reserve_account_id": {
"description": "ID of the Account that holds the reserve. Filterable.",
"type": "string"
},
"upper_limit": {
"description": "Max amount that `account_id` may be overdrawn in total",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The reserve created"
}
},
"summary": "Create a Reserve Account",
"tags": [
"Reserve Account"
]
}
},
"/reserve/{id}": {
"delete": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
}
},
"summary": "Delete a Reserve Account",
"tags": [
"Reserve Account"
]
},
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_1234567890",
"amount": "0.00",
"id": "reserve_1029384756",
"reserve_account_id": "acct_0987654321",
"upper_limit": "100.00",
"userdata": null
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the target Account that has an added reserve limit. Filterable.",
"type": "string"
},
"amount": {
"description": "Amount that `account_id` is currently overdrawn",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bankdata": {
"description": "Optional data for the bank",
"type": "object"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"reserve_account_id": {
"description": "ID of the Account that holds the reserve. Filterable.",
"type": "string"
},
"upper_limit": {
"description": "Max amount that `account_id` may be overdrawn in total",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The reserve"
}
},
"summary": "Fetch a Reserve Account",
"tags": [
"Reserve Account"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"amount": "0.00"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the target Account that has an added reserve limit. Filterable.",
"type": "string"
},
"amount": {
"description": "Amount that `account_id` is currently overdrawn",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bankdata": {
"description": "Optional data for the bank",
"type": "object"
},
"reserve_account_id": {
"description": "ID of the Account that holds the reserve. Filterable.",
"type": "string"
},
"upper_limit": {
"description": "Max amount that `account_id` may be overdrawn in total",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The reserve to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": "acct_1234567890",
"amount": "0.00",
"id": "reserve_1029384756",
"reserve_account_id": "acct_0987654321",
"upper_limit": "100.00",
"userdata": null
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "ID of the target Account that has an added reserve limit. Filterable.",
"type": "string"
},
"amount": {
"description": "Amount that `account_id` is currently overdrawn",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"bankdata": {
"description": "Optional data for the bank",
"type": "object"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"reserve_account_id": {
"description": "ID of the Account that holds the reserve. Filterable.",
"type": "string"
},
"upper_limit": {
"description": "Max amount that `account_id` may be overdrawn in total",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The reserve updated"
}
},
"summary": "Update a Reserve Account",
"tags": [
"Reserve Account"
]
}
},
"/statement_config": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"account_id": null,
"apy": "1.50",
"created_at": "2022-08-19T23:27:03Z",
"email_address": "[email protected]",
"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"
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_id": {
"description": "Specific Account ID to apply statement configuration; if omitted, applies to all accounts",
"type": "string"
},
"apy": {
"description": "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%",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of statement_config elements"
}
},
"summary": "List Configurations",
"tags": [
"Account Documents"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": null,
"apy": "1.50",
"email_address": "[email protected]",
"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"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Specific Account ID to apply statement configuration; if omitted, applies to all accounts",
"type": "string"
},
"apy": {
"description": "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%",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements",
"type": "string"
}
},
"required": [
"apy",
"phone_number",
"footnote",
"id",
"org_legal_name",
"email_address",
"support_url"
]
}
}
},
"description": "The statement_config to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": null,
"apy": "1.50",
"created_at": "2022-08-19T23:27:03Z",
"email_address": "[email protected]",
"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"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Specific Account ID to apply statement configuration; if omitted, applies to all accounts",
"type": "string"
},
"apy": {
"description": "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%",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements",
"type": "string"
}
}
}
}
},
"description": "The statement_config created"
}
},
"summary": "Create a Configuration",
"tags": [
"Account Documents"
]
}
},
"/statement_config/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": null,
"apy": "1.50",
"created_at": "2022-08-19T23:27:03Z",
"email_address": "[email protected]",
"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"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Specific Account ID to apply statement configuration; if omitted, applies to all accounts",
"type": "string"
},
"apy": {
"description": "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%",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements",
"type": "string"
}
}
}
}
},
"description": "The statement_config"
}
},
"summary": "Fetch a Configuration",
"tags": [
"Account Documents"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"apy": "1.75",
"email_address": "[email protected]"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Specific Account ID to apply statement configuration; if omitted, applies to all accounts",
"type": "string"
},
"apy": {
"description": "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%",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements",
"type": "string"
}
}
}
}
},
"description": "The statement_config to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"account_id": null,
"apy": "1.75",
"created_at": "2022-08-19T23:27:03Z",
"email_address": "[email protected]",
"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"
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Specific Account ID to apply statement configuration; if omitted, applies to all accounts",
"type": "string"
},
"apy": {
"description": "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%",
"pattern": "^[0-9][.][0-9][0-9]$",
"type": "string"
},
"email_address": {
"description": "Customer support email address to appear on statements",
"type": "string"
},
"footnote": {
"description": "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.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"logo_file_id": {
"description": "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.",
"type": "string"
},
"org_legal_name": {
"description": "Legal name of your business to appear on statements",
"type": "string"
},
"phone_number": {
"description": "Customer support phone number to appear on statements",
"type": "string"
},
"physical_address": {
"description": "Address object representing the physical address of your business which will appear on statements",
"properties": {
"city": {
"description": "City",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"street_line_1": {
"description": "First line of the address",
"type": "string"
},
"street_line_2": {
"description": "Optional second line of the address",
"type": "string"
}
},
"type": "object"
},
"support_url": {
"description": "Customer support website to appear on statements",
"type": "string"
}
}
}
}
},
"description": "The statement_config updated"
}
},
"summary": "Update a Configuration",
"tags": [
"Account Documents"
]
}
},
"/transaction": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"ach_id": "ach_1234567",
"amount": "1975.00",
"balance": "256147.27",
"billpay_payment_id": null,
"book_id": null,
"card_id": null,
"category": null,
"check_id": null,
"check_number": null,
"date": "2017-11-27",
"desc": "EXT-XFER Sq. Nbr.: 123456",
"extended_timestamp": "2017-11-27T01:02:03Z",
"extended_timestamp_precise": "2017-11-27T01:02:03.400Z",
"fingerprint": "2k7vxetham4i1v3ceb5vs6",
"id": "ttx_113333abcd",
"incoming_ach_id": null,
"incoming_wire": null,
"incoming_wire_id": null,
"issued_check_id": null,
"network_transfer_id": null,
"related_transfer_ids": [],
"summary": "ACME CORP VENDOR PMT",
"trace_id": null,
"type": "deposit",
"type_source": null,
"userdata": null,
"wire": null,
"wire_id": null
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"ach_id": {
"description": "The ID of the ACH object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"amount": {
"description": "Transaction amount. Positive values indicate a credit while negative values indicate a debit. Note that transactions with type hold have an amount, but they do not change the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"balance": {
"description": "Account balance immediately after this transaction. Transactions of type hold do not affect the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"billpay_payment_id": {
"description": "The ID of the BillPay object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"book_id": {
"description": "The ID of the Book Transfer object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"card_id": {
"description": "The ID of the Card Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"category": {
"description": "One of: `interest`, `fees`, or `null`. Update this field to indicate if the transaction is an interest or fee payment",
"type": "string"
},
"check_id": {
"description": "The ID of the Check Deposit object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"check_number": {
"description": "If this transaction is for an outbound check, the number of the check. Otherwise `null`",
"type": "string"
},
"date": {
"description": "Date of the transaction, ISO 8601 format ('YYYY-MM-DD'). Received directly from the bank, often without time zone adjustment. Might differ in date compared to `extended_timestamp` and `extended_timestamp_precise` due to timezones.",
"type": "string"
},
"desc": {
"description": "Transaction description",
"type": "string"
},
"extended_timestamp": {
"description": "Timestamp of the transaction, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC",
"type": "string"
},
"extended_timestamp_precise": {
"description": "Timestamp of the transaction, ISO 8601 format with subsecond precision ('YYYY-MM-DDThh:mm:ss.SSS[SSS]Z'). The precision could be millisecond or microsecond depending on source data. Limited availability. Always in UTC.",
"type": "string"
},
"fingerprint": {
"description": "A unique fingerprint for this transaction",
"type": "string"
},
"human_readable_description": {
"description": "A user-friendly description. Note, there may be a short period (less than 60 seconds) after a transaction is accessible through our API where this field is not yet populated.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"incoming_ach_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"incoming_wire": {
"description": "Data related to the wire that originated this transaction, if any. Otherwise `null`",
"type": "object"
},
"incoming_wire_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"issued_check_id": {
"description": "The ID of the Issued Check Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"network_transfer_id": {
"description": "The ID of the Network Transfer that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"related_transfer_ids": {
"description": "The IDs of the related transactions, if any. Otherwise `null`",
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"description": "Summary description of the transaction",
"type": "string"
},
"trace_id": {
"description": "A common id used to tie multiple, related transactions together. Currently used to connect `hold` and `hold_release` transactions to a `debit` and to link transactions to their related card events. Filterable.",
"type": "string"
},
"type": {
"description": "Type of transaction. One of `charge`, `deposit`, `hold`, `hold_release`, `interest`, `payment`, `reversal`, `withdrawal`, or `null`. Filterable.",
"type": "string"
},
"type_source": {
"description": "The type of payment that initiated this transaction, if any. One of `ach`, `bank`, `book`, `card`, `check`, or `wire`. Otherwise `null`. Limited availability.",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
},
"wire": {
"description": "For wire transactions, the Fedwire description, if any. Otherwise `null`.",
"type": "string"
},
"wire_id": {
"description": "The ID of the Wire object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of transaction elements"
}
},
"summary": "List Transactions",
"tags": [
"Transaction"
]
}
},
"/transaction/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"ach_id": "ach_1234567",
"amount": "1975.00",
"balance": "256147.27",
"billpay_payment_id": null,
"book_id": null,
"card_id": null,
"category": null,
"check_id": null,
"check_number": null,
"date": "2017-11-27",
"desc": "EXT-XFER Sq. Nbr.: 123456",
"extended_timestamp": "2017-11-27T01:02:03Z",
"extended_timestamp_precise": "2017-11-27T01:02:03.400Z",
"fingerprint": "2k7vxetham4i1v3ceb5vs6",
"id": "ttx_113333abcd",
"incoming_ach_id": null,
"incoming_wire": null,
"incoming_wire_id": null,
"issued_check_id": null,
"network_transfer_id": null,
"related_transfer_ids": [],
"summary": "ACME CORP VENDOR PMT",
"trace_id": null,
"type": "deposit",
"type_source": null,
"userdata": null,
"wire": null,
"wire_id": null
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"ach_id": {
"description": "The ID of the ACH object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"amount": {
"description": "Transaction amount. Positive values indicate a credit while negative values indicate a debit. Note that transactions with type hold have an amount, but they do not change the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"balance": {
"description": "Account balance immediately after this transaction. Transactions of type hold do not affect the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"billpay_payment_id": {
"description": "The ID of the BillPay object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"book_id": {
"description": "The ID of the Book Transfer object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"card_id": {
"description": "The ID of the Card Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"category": {
"description": "One of: `interest`, `fees`, or `null`. Update this field to indicate if the transaction is an interest or fee payment",
"type": "string"
},
"check_id": {
"description": "The ID of the Check Deposit object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"check_number": {
"description": "If this transaction is for an outbound check, the number of the check. Otherwise `null`",
"type": "string"
},
"date": {
"description": "Date of the transaction, ISO 8601 format ('YYYY-MM-DD'). Received directly from the bank, often without time zone adjustment. Might differ in date compared to `extended_timestamp` and `extended_timestamp_precise` due to timezones.",
"type": "string"
},
"desc": {
"description": "Transaction description",
"type": "string"
},
"extended_timestamp": {
"description": "Timestamp of the transaction, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC",
"type": "string"
},
"extended_timestamp_precise": {
"description": "Timestamp of the transaction, ISO 8601 format with subsecond precision ('YYYY-MM-DDThh:mm:ss.SSS[SSS]Z'). The precision could be millisecond or microsecond depending on source data. Limited availability. Always in UTC.",
"type": "string"
},
"fingerprint": {
"description": "A unique fingerprint for this transaction",
"type": "string"
},
"human_readable_description": {
"description": "A user-friendly description. Note, there may be a short period (less than 60 seconds) after a transaction is accessible through our API where this field is not yet populated.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"incoming_ach_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"incoming_wire": {
"description": "Data related to the wire that originated this transaction, if any. Otherwise `null`",
"type": "object"
},
"incoming_wire_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"issued_check_id": {
"description": "The ID of the Issued Check Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"network_transfer_id": {
"description": "The ID of the Network Transfer that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"related_transfer_ids": {
"description": "The IDs of the related transactions, if any. Otherwise `null`",
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"description": "Summary description of the transaction",
"type": "string"
},
"trace_id": {
"description": "A common id used to tie multiple, related transactions together. Currently used to connect `hold` and `hold_release` transactions to a `debit` and to link transactions to their related card events. Filterable.",
"type": "string"
},
"type": {
"description": "Type of transaction. One of `charge`, `deposit`, `hold`, `hold_release`, `interest`, `payment`, `reversal`, `withdrawal`, or `null`. Filterable.",
"type": "string"
},
"type_source": {
"description": "The type of payment that initiated this transaction, if any. One of `ach`, `bank`, `book`, `card`, `check`, or `wire`. Otherwise `null`. Limited availability.",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
},
"wire": {
"description": "For wire transactions, the Fedwire description, if any. Otherwise `null`.",
"type": "string"
},
"wire_id": {
"description": "The ID of the Wire object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
}
}
}
}
},
"description": "The transaction"
}
},
"summary": "Fetch a Transaction",
"tags": [
"Transaction"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Specify category",
"value": {
"category": "interest"
}
}
},
"schema": {
"properties": {
"category": {
"description": "One of: `interest`, `fees`, or `null`. Update this field to indicate if the transaction is an interest or fee payment",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
}
}
}
}
},
"description": "The transaction to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"ach_id": "ach_1234567",
"amount": "1975.00",
"balance": "256147.27",
"billpay_payment_id": null,
"book_id": null,
"card_id": null,
"category": "interest",
"check_id": null,
"check_number": null,
"date": "2017-11-27",
"desc": "EXT-XFER Sq. Nbr.: 123456",
"extended_timestamp": "2017-11-27T01:02:03Z",
"extended_timestamp_precise": "2017-11-27T01:02:03.400Z",
"fingerprint": "2k7vxetham4i1v3ceb5vs6",
"id": "ttx_113333abcd",
"incoming_ach_id": null,
"incoming_wire": null,
"incoming_wire_id": null,
"issued_check_id": null,
"network_transfer_id": null,
"related_transfer_ids": [],
"summary": "ACME CORP VENDOR PMT",
"trace_id": null,
"type": "deposit",
"type_source": null,
"userdata": null,
"wire": null,
"wire_id": null
}
}
},
"schema": {
"properties": {
"account_id": {
"description": "Account ID",
"type": "string"
},
"ach_id": {
"description": "The ID of the ACH object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"amount": {
"description": "Transaction amount. Positive values indicate a credit while negative values indicate a debit. Note that transactions with type hold have an amount, but they do not change the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"balance": {
"description": "Account balance immediately after this transaction. Transactions of type hold do not affect the balance.",
"pattern": "^-?[0-9]+[.][0-9][0-9]$",
"type": "string"
},
"billpay_payment_id": {
"description": "The ID of the BillPay object that originated this transaction, if any. Otherwise `null`",
"type": "string"
},
"book_id": {
"description": "The ID of the Book Transfer object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"card_id": {
"description": "The ID of the Card Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"category": {
"description": "One of: `interest`, `fees`, or `null`. Update this field to indicate if the transaction is an interest or fee payment",
"type": "string"
},
"check_id": {
"description": "The ID of the Check Deposit object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"check_number": {
"description": "If this transaction is for an outbound check, the number of the check. Otherwise `null`",
"type": "string"
},
"date": {
"description": "Date of the transaction, ISO 8601 format ('YYYY-MM-DD'). Received directly from the bank, often without time zone adjustment. Might differ in date compared to `extended_timestamp` and `extended_timestamp_precise` due to timezones.",
"type": "string"
},
"desc": {
"description": "Transaction description",
"type": "string"
},
"extended_timestamp": {
"description": "Timestamp of the transaction, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC",
"type": "string"
},
"extended_timestamp_precise": {
"description": "Timestamp of the transaction, ISO 8601 format with subsecond precision ('YYYY-MM-DDThh:mm:ss.SSS[SSS]Z'). The precision could be millisecond or microsecond depending on source data. Limited availability. Always in UTC.",
"type": "string"
},
"fingerprint": {
"description": "A unique fingerprint for this transaction",
"type": "string"
},
"human_readable_description": {
"description": "A user-friendly description. Note, there may be a short period (less than 60 seconds) after a transaction is accessible through our API where this field is not yet populated.",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"incoming_ach_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"incoming_wire": {
"description": "Data related to the wire that originated this transaction, if any. Otherwise `null`",
"type": "object"
},
"incoming_wire_id": {
"description": "The ID of the Incoming ACH object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"issued_check_id": {
"description": "The ID of the Issued Check Object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"network_transfer_id": {
"description": "The ID of the Network Transfer that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
},
"related_transfer_ids": {
"description": "The IDs of the related transactions, if any. Otherwise `null`",
"items": {
"type": "string"
},
"type": "array"
},
"summary": {
"description": "Summary description of the transaction",
"type": "string"
},
"trace_id": {
"description": "A common id used to tie multiple, related transactions together. Currently used to connect `hold` and `hold_release` transactions to a `debit` and to link transactions to their related card events. Filterable.",
"type": "string"
},
"type": {
"description": "Type of transaction. One of `charge`, `deposit`, `hold`, `hold_release`, `interest`, `payment`, `reversal`, `withdrawal`, or `null`. Filterable.",
"type": "string"
},
"type_source": {
"description": "The type of payment that initiated this transaction, if any. One of `ach`, `bank`, `book`, `card`, `check`, or `wire`. Otherwise `null`. Limited availability.",
"type": "string"
},
"userdata": {
"description": "Arbitrary user data that can be attached to the object",
"type": "object"
},
"wire": {
"description": "For wire transactions, the Fedwire description, if any. Otherwise `null`.",
"type": "string"
},
"wire_id": {
"description": "The ID of the Wire object that originated this transaction, if any. Otherwise `null`. Filterable.",
"type": "string"
}
}
}
}
},
"description": "The transaction updated"
}
},
"summary": "Update a Transaction",
"tags": [
"Transaction"
]
}
}
},
"security": [
{
"basicAuth": []
},
{
"apiKey": []
}
],
"servers": [
{
"description": "Production",
"url": "https://api.treasuryprime.com"
},
{
"description": "Sandbox",
"url": "https://api.sandbox.treasuryprime.com"
}
]
}Updated 7 days ago