Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Enhanced FDIC Insurance

Update a Deposit Sweep

patch/deposit_sweep/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Request body

opted_inboolean

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

threshold_balancestring

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

The deposit_sweep updated

account_idstring

ID of the Account associated with the Deposit Sweep object

bank_idstring

ID of the bank for the deposit sweep account

customer_emailstring

Email address of the primary customer associated with the deposit sweep account. This is the email that would be used for enrollment in the deposit sweep network.

customer_idstring

ID of the primary customer (person or business) associated with the deposit sweep account. This is the customer that would be used for enrollment in the deposit sweep network.

customer_identifierstring

The identifier used with the deposit sweep network for the customer. This will be a masked TIN (for US entities with a TIN) or the unique portion of the customer ID (for foreign entities without a TIN).

idstring

Unique identifier for object

networkstring

Name of the deposit sweep network associated with the object

network_account_idstring

Identifier used with the network for the deposit sweep account

opted_inboolean

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

sweep_balancestring

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_balancestring

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.