POST
/
deposit_sweep
curl --request POST \
  --url https://api.treasuryprime.com/deposit_sweep \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "acct_11hryybpgdc399",
  "network": "network-name",
  "opted_in": true,
  "threshold_balance": "250000.00"
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
The deposit_sweep to create
​
account_id
string
required

ID of the Account associated with the Deposit Sweep object

​
network
string
required

Name of the deposit sweep network associated with the object

​
opted_in
boolean
required

Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program

​
threshold_balance
string
required

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.

Response

200 - application/json
The deposit_sweep created
​
account_id
string

ID of the Account associated with the Deposit Sweep object

​
bank_id
string

ID of the bank for the deposit sweep account

​
id
string

Unique identifier for object

​
network
string

Name of the deposit sweep network associated with the object

​
network_account_id
string

Identifier used with the network for the deposit sweep account

​
opted_in
boolean

Boolean identifying whether the account is currently opted in to the Enhanced FDIC insurance program

​
sweep_balance
string

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.

​
threshold_balance
string

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.

Was this page helpful?