PATCH
/
account
/
{id}
curl --request PATCH \
  --url https://api.treasuryprime.com/account/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lock": {
    "additional_context": "ach_123453254 is disputed by customer.",
    "reason": "transactions_being_investigated_ACH"
  },
  "locked": true
}'
{
  "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
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique identifier for object

Body

application/json
The account to update
lock
object

Object containing details pertaining to placing a lock on an account

locked
boolean

true if the account should be locked

mailing_address
object

Mailing address of the account

physical_address
object

Physical address of the account

status
string

Updated status of the account. One of: close_pending. Cannot be passed with locked set to true

tags
string[]

Array of tags associated with this account. Filterable.

userdata
object

Arbitrary user data that can be attached to the object

Response

200 - application/json
The account updated
account_number
string

Bank account number. Filterable.

account_product_id
string

Account Product used to create the account

account_type
string

One of checking or savings

additional_account_numbers
string[]

Invoice account numbers associated with the account

address
object
deprecated

Address associated with the account

available_balance
string

Available funds in this account. If not available, the value will be null

bank_id
string

ID of the bank with which the account is associated

business_ids
string[]

Array of IDs of Business objects representing all businesses that own this account. Always empty for personal accounts

currency
string

Three-letter ISO currency code in lowercase, indicating the currency denominating the account. Currently only USD is supported

current_balance
string

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

funded
boolean

true if the account has ever been funded with an amount greater than $0, false otherwise

id
string

Unique identifier for object

interest_rate
any
lock
object

Details related to account lock (returned only when locked is true).

locked
boolean

true if the account is in a locked state, false otherwise

mailing_address
object

Mailing address associated with the account

name
string
deprecated

Name of the person or company that owns the bank account

org_id
string

ID of the organization with which the account is associated. Filterable.

person_ids
string[]

Array of IDs of Person objects representing all people who own this account

physical_address
object

Physical address associated with the account

primary_person_id
string

ID of the Person indicating the primary account holder

routing_number
string

ABA routing transit number associated with the account

status
string

The status of the account. One of open, closed, or close_pending

tags
string[]

Array of tags associated with this account. Filterable.

userdata
object

Arbitrary user data that can be attached to the object