Skip to main content

Deposit Accounts

Deposit Accounts are bank accounts maintained by a financial institution, in which a customer can deposit and withdraw money. Deposit accounts can be checking accounts, savings accounts, or any of several other types.

Unit deposit accounts can belong to an individual customer, multiple customers (joint account) or business customers.

info
Joint accounts are deposit accounts that are assigned to multiple individual customers. Some of the use cases for joint accounts are family members/spouses using it to manage shared funds, or parents creating joint accounts with their children, to provide them with access to banking services and cards.

To create a joint account, you would have to provide an array of two or more Customers as part of the Create Account API call. At least one of the customers must be over 18 years old.

Create Deposit Account#

Creates a deposit account for a Customer (or customers) using a specified deposit product. A deposit product is a predefined set of terms associated with this deposit account (e.g. interest rate).

note

For testing, use the checking deposit product. Contact Unit to create other deposit products under your organization.

Deposit Account creation request supports Idempotency, ensuring that performing multiple identical requests will have the same effect as performing a single request.

VerbPOST
Urlhttps://api.s.unit.sh/accounts
Required Scopeaccounts-write
Data TypedepositAccount

Attributes#

NameTypeDescription
depositProductstringThe name of the deposit product.
tagsobjectSee Tags.
idempotencyKeystringSee Idempotency.

Relationships#

NameTypeDescription
customerRequired for individual / business accounts. JSON:API RelationshipThe customer the deposit account belongs to. The customer is either a business or an individual.
customersRequired for joint accounts. Array of JSON:API RelationshipThe list of customers the deposit account belongs to. Each of the customers is an individual customer and at least one must be over 18 years old.
caution

You must provide exactly one of customer or customers.

Example Request:
curl -X POST 'https://api.s.unit.sh/accounts'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{  "data": {    "type": "depositAccount",    "attributes": {      "depositProduct": "checking",      "tags": {        "purpose": "checking"      },      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"    },    "relationships": {      "customer": {        "data": {          "type": "customer",          "id": "45555"        }      }    }  }}'

Response#

Response is a JSON:API document.

201 Created#

FieldTypeDescription
dataDepositAccountThe requested resource after the operation was completed.
Example Response:
{  "data": {    "type": "depositAccount",    "id": "42",    "attributes": {      "createdAt": "2000-05-11T10:19:30.409Z",      "name": "Peter Parker",      "status": "Open",      "depositProduct": "checking",      "routingNumber": "812345678",      "accountNumber": "1000000002",      "currency": "USD",      "balance": 10000,      "hold": 0,      "available": 10000,      "tags": {        "purpose": "checking"      }    },    "relationships": {      "customer": {        "data": {          "type": "customer",          "id": "45555"        }      }    }  }}

Close Account#

Closes an account.

VerbPOST
Urlhttps://api.s.unit.sh/accounts/:accountId/close
Required Scopeaccounts-write
Data TypeaccountClose

Attributes#

NameTypeDescription
reasonstringOptional. The reason for closing the account. Either ByCustomer or Fraud. If not specified, will default to ByCustomer.

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataDepositAccountDeposit Account resource.
curl -X POST 'https://api.s.unit.sh/accounts/10000/close'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{}'

Reopen Account#

Reopen an account.

VerbPOST
Urlhttps://api.s.unit.sh/accounts/:accountId/reopen
Required Scopeaccounts-write

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataDepositAccountDeposit Account resource.
curl -X POST 'https://api.s.unit.sh/accounts/10000/reopen'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{}'

Get by Id#

Get a deposit account resource by id.

VerbGET
Urlhttps://api.s.unit.sh/accounts/{id}
Required Scopeaccounts

Query Parameters#

NameTypeDefaultDescription
includestring(empty)Optional. Related resource available to include: customer. See Getting Related Resources

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataDepositAccountThe requested resource after the operation was completed.
includedArray of CustomerArray of resources requested by the include query parameter.
curl -X POST 'https://api.s.unit.sh/accounts/42' \-H "Authorization: Bearer ${TOKEN}"

List#

List deposit account resources. Paging can be applied.

VerbGET
Urlhttps://api.s.unit.sh/accounts
Required Scopeaccounts

Query Parameters#

NameTypeDefaultDescription
page[limit]integer100Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]integer0Number of resources to skip. See Pagination.
filter[customerId]string(empty)Optional. Filters the results by the specified customer id.
filter[tags]Tags (JSON)(empty)Optional. Filter Accounts by Tags.
includestring(empty)Optional. Related resource available to include: customer. See Getting Related Resources
curl -X POST 'https://api.s.unit.sh/accounts?page[limit]=20&page[offset]=10' \-H "Authorization: Bearer ${TOKEN}"

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataArray of DepositAccountArray of deposit account resources.
includedArray of CustomerArray of resources requested by the include query parameter.
Example Response:
{  "data": [    {      "type": "depositAccount",      "id": "42",      "attributes": {        "createdAt": "2000-05-11T10:19:30.409Z",        "name": "Peter Parker",        "status": "Open",        "depositProduct": "checking",        "routingNumber": "812345678",        "accountNumber": "1000000002",        "currency": "USD",        "balance": 10000,        "hold": 0,        "available": 10000,        "tags": {          "purpose": "tax"        }      },      "relationships": {        "customer": {          "data": {            "type": "customer",            "id": "45555"          }        }      }    }  ]}

Update#

Update a deposit account.

VerbPATCH
Urlhttps://api.s.unit.sh/accounts/:accountId
Data TypedepositAccount

Attributes#

NameTypeDescription
tagsobjectOptional. See Updating Tags.
depositProductstringOptional. Name of the selected deposit product (you can get the list of available deposit products using a dedicated API endpoint).
note

Deposit product replacement API is not enabled by default for all customers. Please contact Unit if you need to enable this functionality.

curl -X PATCH 'https://api.s.unit.sh/accounts/42'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{  "data": {    "type": "depositAccount",    "attributes": {      "tags": {        "purpose": "Tax",        "trackUserId": null,        "newTag": "New tag value"      },      "depositProduct": "checking"    }  }}'

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataDepositAccountThe requested resource after the operation was completed.
Example Response:
{  "data": {    "type": "depositAccount",    "id": "42",    "attributes": {      "createdAt": "2000-05-11T10:19:30.409Z",      "name": "Peter Parker",      "status": "Open",      "depositProduct": "checking",      "routingNumber": "812345678",      "accountNumber": "1000000002",      "currency": "USD",      "balance": 10000,      "hold": 0,      "available": 10000,      "tags": {        "purpose": "checking"      }    },    "relationships": {      "customer": {        "data": {          "type": "customer",          "id": "45555"        }      }    }  }}

Limits#

VerbGET
Urlhttps://api.s.unit.sh/accounts/:accountId/limits
curl -X POST 'https://api.s.unit.sh/accounts/10104/limits' \-H "Authorization: Bearer ${TOKEN}"

Monetary transactions (such as originating ACH payments, ATM withdrawals or deposits) are subjected to daily and monthly amount limits. Once the limit is reached, the transaction will be rejected. The limits are determined by us and are set in the terms configured in your account’s deposit product. You may contact Unit to change the limits for an account or a group of accounts.

The daily limits are reset at 7:00 p.m. EST. The monthly limits are reset on the first of each month. We provide an API to query the current limits (and daily/monthly totals) for your account.

{  "data": {    "type": "limits",    "attributes": {      "ach": {        "limits": {          "dailyDebit": 50000,          "dailyCredit": 50000,          "monthlyDebit": 2000000,          "monthlyCredit": 2000000        },        "totalsDaily": {          "debits": 25000,          "credits": 10000        },        "totalsMonthly": {          "debits": 800300,          "credits": 250000        }      },      "card": {        "limits": {          "dailyWithdrawal": 500000,          "dailyDeposit": 500000,          "dailyPurchase": 500000        },        "totalsDaily": {          "withdrawals": 25000,          "deposits": 0,          "purchases": 12500        }      }    }  }}

Get Available Deposit Products#

VerbGET
Urlhttps://api.s.unit.sh/accounts/:accountId/deposit-products

List of available deposit products compatible to the account.

curl -X GET 'https://api.s.unit.sh/accounts/10104/deposit-products' \-H "Authorization: Bearer ${TOKEN}"
Example Response:
{    "data": [        {            "type": "accountDepositProduct",            "attributes": {                "name": "checking"            }        },        {            "type": "accountDepositProduct",            "attributes": {                "name": "revenue_bank"            }        }    ]}

Get Account Balance History#

List account end-of-day balances history (filtering and paging can be applied).

The account balance history can be used to provide the customer with an overview of their balance across account(s) over time in a visually engaging way, providing insights and creating custom product features around it.

Account Balance Chart
note

The typical cutoff time (end-of-day) is 7PM, but may vary between banks. The exact time and timezone are determined by the partner bank you work with.

VerbGET
Urlhttps://api.s.unit.sh/account-end-of-day
Required Scopeaccount-end-of-day

Query Parameters#

NameTypeDefaultDescription
page[limit]integer100Maximum number of resources that will be returned. Maximum is 1000 resources.
page[offset]integer0Number of resources to skip.
filter[accountId]string(empty)Optional. Filters the results by the specified account id.
filter[customerId]string(empty)Optional. Filters the results by the specified customer id.
filter[since]ISO Local Date string(empty)Optional. Filters the account end-of-day balances before the specified date. e.g. 2021-06-01
filter[until]ISO Local Date string(empty)Optional. Filters the account end-of-day balances after the specified date. e.g. 2021-07-01
curl -X POST 'https://api.s.unit.sh/account-end-of-day?page[limit]=10&page[offset]=0&filter[customerId]=10000&filter[accountId]=30317&filter[since]=2020-10-11&filter[until]=2021-10-13' \-H "Authorization: Bearer ${TOKEN}"

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataArray of Account End-Of-DayArray of account end-of-day resources.
Example Response:
{  "data": [    {      "type": "accountEndOfDay",      "id": "4925158",      "attributes": {        "date": "2021-07-10",        "balance": 1000,        "available": 500,        "hold": 500      },      "relationships": {        "customer": {          "data": {            "type": "customer",            "id": "10000"          }        },        "account": {          "data": {            "type": "account",            "id": "30317"          }        }      }    },    {      "type": "accountEndOfDay",      "id": "4925158",      "attributes": {        "date": "2021-07-11",        "balance": 1000,        "available": 500,        "hold": 500      },      "relationships": {        "customer": {          "data": {            "type": "customer",            "id": "10000"          }        },        "account": {          "data": {            "type": "account",            "id": "30317"          }        }      }    }  ]}