--- title: "Get an Account object" method: GET path: "/rest/accounts/{account_id}" tags: ["Accounts"] --- # Get an Account object `GET /rest/accounts/{account_id}` ## Request - Base URL: `https://api.dailypay.com` - URL: `https://api.dailypay.com/rest/accounts/{account_id}` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `https://auth.dailypay.com/oauth2/token` scopes: `client:lookup`, `client:admin` - OAuth 2 - Authorization code: `https://auth.dailypay.com/oauth2/auth` - Token URL: `https://auth.dailypay.com/oauth2/token` scopes: `user:read` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns details about an account. This object represents a person's bank accounts, debit and pay cards, and earnings balance accounts. ## Response `200` Returns the account object. - AccountData - `data` AccountResource, required - `id` string, uuid, required: The unique identifier of the Account. - `type` 'accounts', required: The type of the resource. Always `accounts`. - `attributes` union, required: The details of the account. - object: An account with type `CARD` and subtype `DAILYPAY` or `DEBIT`. - `verification_status` 'VERIFICATION_PENDING' | 'VERIFICATION_FAILED' | 'VERIFIED', required: A code that indicates the status of an account that is a destination for funds. - `balances` object, required - `available` integer, nullable, required: The amount of funds available to be withdrawn from the account. For earnings_balance-type accounts, the available balance typically equals the current balance less any pending outflows, plus any pending inflows, This value is in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: 'USD' }` resolves to $72.50. - `current` integer, nullable, required: The total amount of funds settled in the account. This value is in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: 'USD' }` resolves to $72.50. **Special note for Earnings Balance accounts:** If a user transfers money from an Earnings Balance account to a personal account, the `current` balance may be negative as those transfers settle. When a paycheck is processed, DailyPay will automatically attempt to zero out the balance, transferring any remaining funds to the `direct_deposit_default_depository` account set for the associated Job. If DailyPay is unable to zero out the balance during paycheck processing, the `current` balance will remain negative, which may impact a user's ability to transfer additional funds from their earnings balance. In those cases, the available balance will be 0. - `currency` string, required: A three-letter ISO 4217 currency code. For example, `USD` for US Dollars, `EUR` for Euros, or `JPY` for Japanese Yen. - `capabilities` object, required - `transfer_destination` TransferDestinationCapability[], required: List of the timing and associate fees available when crediting this account as a transfer destination. Actual fees may differ at the time of transfer; please refer to the transfer preview attribute for the most accurate fee information for any given transfer. - `schedule` 'WITHIN_THIRTY_MINUTES' | 'NEXT_BUSINESS_DAY', required: The expected time for the transfer to be completed. - `fee` integer, required: A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, `{ amount: 299, currency: 'USD' }` resolves to $2.99. If a transfer incurs a fee, the fee will be deducted from the amount of the transfer. - `currency` string, required: A three-letter ISO 4217 currency code. For example, `USD` for US Dollars, `EUR` for Euros, or `JPY` for Japanese Yen. - `name` string, required: Display name for this account. - `account_type` 'CARD', required: The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay). - `subtype` 'DEBIT' | 'DAILYPAY', required: The subtype of the account. Additional subtypes may be added over time - `details` object, required: The banking details of the account and account holder. - `last_four` string, required: Last four digits of the card number. - `issuer` string, required: The issuer of the card. - `first_name` string, required: The first name of the account holder. - `last_name` string, required: The last name of the account holder. - `expiration_month` string, required: The month of the expiration date for the card. - `expiration_year` string, required: The year of the expiration date for the card. - object: An account with type `EARNINGS_BALANCE` and subtype `ODP`. - `verification_status` 'VERIFICATION_PENDING' | 'VERIFICATION_FAILED' | 'VERIFIED', required: A code that indicates the status of an account that is a destination for funds. - `balances` object, required - `available` integer, nullable, required: The amount of funds available to be withdrawn from the account. For earnings_balance-type accounts, the available balance typically equals the current balance less any pending outflows, plus any pending inflows, This value is in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: 'USD' }` resolves to $72.50. - `current` integer, nullable, required: The total amount of funds settled in the account. This value is in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: 'USD' }` resolves to $72.50. **Special note for Earnings Balance accounts:** If a user transfers money from an Earnings Balance account to a personal account, the `current` balance may be negative as those transfers settle. When a paycheck is processed, DailyPay will automatically attempt to zero out the balance, transferring any remaining funds to the `direct_deposit_default_depository` account set for the associated Job. If DailyPay is unable to zero out the balance during paycheck processing, the `current` balance will remain negative, which may impact a user's ability to transfer additional funds from their earnings balance. In those cases, the available balance will be 0. - `currency` string, required: A three-letter ISO 4217 currency code. For example, `USD` for US Dollars, `EUR` for Euros, or `JPY` for Japanese Yen. - `capabilities` object, required - `transfer_destination` TransferDestinationCapability[], required: List of the timing and associate fees available when crediting this account as a transfer destination. Actual fees may differ at the time of transfer; please refer to the transfer preview attribute for the most accurate fee information for any given transfer. - `schedule` 'WITHIN_THIRTY_MINUTES' | 'NEXT_BUSINESS_DAY', required: The expected time for the transfer to be completed. - `fee` integer, required: A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, `{ amount: 299, currency: 'USD' }` resolves to $2.99. If a transfer incurs a fee, the fee will be deducted from the amount of the transfer. - `currency` string, required: A three-letter ISO 4217 currency code. For example, `USD` for US Dollars, `EUR` for Euros, or `JPY` for Japanese Yen. - `name` string, required: Display name for this account. - `account_type` 'EARNINGS_BALANCE', required: The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay). - `subtype` 'ODP', required: The subtype of the account. - `details` object, required: An empty object for earnings balance accounts. - object: An account with type `DEPOSITORY` and subtype `SAVINGS` or `CHECKING`. - `verification_status` 'VERIFICATION_PENDING' | 'VERIFICATION_FAILED' | 'VERIFIED', required: A code that indicates the status of an account that is a destination for funds. - `balances` object, required - `available` integer, nullable, required: The amount of funds available to be withdrawn from the account. For earnings_balance-type accounts, the available balance typically equals the current balance less any pending outflows, plus any pending inflows, This value is in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: 'USD' }` resolves to $72.50. - `current` integer, nullable, required: The total amount of funds settled in the account. This value is in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: 'USD' }` resolves to $72.50. **Special note for Earnings Balance accounts:** If a user transfers money from an Earnings Balance account to a personal account, the `current` balance may be negative as those transfers settle. When a paycheck is processed, DailyPay will automatically attempt to zero out the balance, transferring any remaining funds to the `direct_deposit_default_depository` account set for the associated Job. If DailyPay is unable to zero out the balance during paycheck processing, the `current` balance will remain negative, which may impact a user's ability to transfer additional funds from their earnings balance. In those cases, the available balance will be 0. - `currency` string, required: A three-letter ISO 4217 currency code. For example, `USD` for US Dollars, `EUR` for Euros, or `JPY` for Japanese Yen. - `capabilities` object, required - `transfer_destination` TransferDestinationCapability[], required: List of the timing and associate fees available when crediting this account as a transfer destination. Actual fees may differ at the time of transfer; please refer to the transfer preview attribute for the most accurate fee information for any given transfer. - `schedule` 'WITHIN_THIRTY_MINUTES' | 'NEXT_BUSINESS_DAY', required: The expected time for the transfer to be completed. - `fee` integer, required: A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, `{ amount: 299, currency: 'USD' }` resolves to $2.99. If a transfer incurs a fee, the fee will be deducted from the amount of the transfer. - `currency` string, required: A three-letter ISO 4217 currency code. For example, `USD` for US Dollars, `EUR` for Euros, or `JPY` for Japanese Yen. - `name` string, required: Display name for this account. - `account_type` 'DEPOSITORY', required: The type of account. It differentiates between depository accounts (e.g. bank account), cards (e.g. debit) and earnings balance type of accounts (e.g. on demand pay). - `subtype` 'SAVINGS' | 'CHECKING', required: The subtype of the account. - `details` object, required: The banking details of the account and account holder. - `first_name` string, required: The first name of the account holder. - `last_name` string, required: The last name of the account holder. - `routing_number` string, required: The routing number of the bank that holds this account. Responses from this API that return this number are masked to the last four digits. - `account_number` string, required: The account number. Responses from this API that return this number are masked to the last four digits. - `links` AccountLinks, required - `self` string, uri, required: The URI for the account - `relationships` AccountRelationships, required - `person` PersonRelationship, required - `data` PersonIdentifier, required - `type` 'people', required - `id` string, uuid, required ## Other responses - `400`: Bad Request - `401`: Invalid authentication credentials - `403`: Not authorized to perform this operation - `404`: Resource was not found - `500`: Unexpected error occured --- [API](https://skmtc.dev/dailypay/apis/dailypay-rest-api.md) - [All operations](https://skmtc.dev/dailypay/apis/dailypay-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dailypay/apis/dailypay-rest-api/revisions/24f4c159e842?raw)