CHchariot-giving
Accounts

Get account

Get account balances, liabilities, and other detailed account information for a single deposit account.

Chariot is a financial technology company, not a bank. Chariot Accounts come with a Demand Deposit Account through our banking services partner, Column N.A., Member FDIC.

get/accounts/{id}

Request

  • Base URL
    https://api.givechariot.com/fdx/v6
  • URL
    https://api.givechariot.com/fdx/v6/accounts/{id}
  • Auth
    OAuth 2
    Authorization code: https://dashboard.givechariot.com/oauth/authorize
    Token URL: https://api.givechariot.com/auth/oauth/token

Path parameters

idstring uuid required

Unique identifier for the account

Response

The deposit account details including balances

accountCategory'DEPOSIT_ACCOUNT' required

Category of account

accountType'CHECKING' required

Type of deposit account

accountIdstring required

Unique identifier for the account

accountNumberstring required

Full account number

accountNumberDisplaystring required

Masked or truncated account number for display

productNamestring required

Product name for the account

nickNamestring

User-assigned nickname for the account

nicknamestring

Alternate nickname field

status'OPEN' | 'CLOSED' | 'DELINQUENT' | 'NEGATIVECURRENTBALANCE' | 'PAID' | 'PENDINGCLOSE' | 'PENDINGOPEN' | 'RESTRICTED' required

Status of the account

descriptionstring

Description of the account

accountOpenDatestring date required

Date the account was opened (YYYY-MM-DD)

accountCloseDatestring date

Date the account was closed (YYYY-MM-DD). Present only for closed accounts.

currentBalancenumber double required

Current balance of the account

availableBalancenumber double required

Available balance of the account

balanceAsOfstring date-time

Timestamp of when the balance was calculated

lineOfBusinessstring

Line of business for the account

routingTransitNumberstring required

Routing transit number (RTN) for the account

balanceType'ASSET' required

Type of balance

interestRatenumber double

Interest rate for the account

transferInboolean

Whether the account supports incoming transfers

transferOutboolean

Whether the account supports outgoing transfers

Example response

{
  "currency": {
    "currencyCode": "USD"
  }
}

Changes

No recorded changes to this operation across all 12 revisions of this API.