logo

Accounts

The accounts endpoint provides comprehensive information about money accounts. You can retrieve account details, including the account's unique ID, a link to the account holder, type, subtype, verification status, balance details, transfer capabilities, and user-specific information such as names, routing numbers, and partial account numbers.

Functionality: Access detailed user account information, verify account balances, view transfer capabilities, and access user-specific details associated with each account.

Get an Account object

Returns details about an account. This object represents a person's bank accounts, debit and pay cards, and earnings balance accounts.

Securityoauth_user_token or oauth_client_credentials_token
Request
path Parameters
account_id
required
string <uuid>

Unique UUID of the Account.

Example: 2bc7d781-3247-46f6-b60f-4090d214936a
header Parameters
DailyPay-API-Version
integer
Default: 3

The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

Example: 3
Accept
required
string

The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format. For more details, see https://jsonapi.org.

Value: "application/vnd.api+json"
Responses
200

Returns the account object.

Response Schema: application/vnd.api+json
required
object (AccountResource)
id
required
string <uuid>

The unique identifier of the Account.

Example: "2bc7d781-3247-46f6-b60f-4090d214936a"
type
required
string

The type of the resource. Always accounts.

Example: "accounts"
Value: "accounts"
required
AccountAttributes_Card (object) or AccountAttributes_EarningsBalance (object) or AccountAttributes_Depository (object) (AccountAttributes)
One of:

The details of the account.

verification_status
required
string

A code that indicates the status of an account that is a destination for funds.

Enum: "VERIFICATION_PENDING" "VERIFICATION_FAILED" "VERIFIED"
Example: "VERIFIED"
required
object
required
object
name
string

Display name for this account.

Example: "Debit Card"
account_type
required
string

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).

Value: "CARD"
subtype
required
string

The subtype of the account.

Enum: "DEBIT" "GALILEO" "WISELY"
Example: "DEBIT"
required
subtype: DEBIT (object) or subtype: GALILEO (object) or subtype: WISELY (object)

The banking details of the account and account holder.

required
object (AccountLinks)
self
required
string <uri> (AccountLink)

The URI for the account

required
object (AccountRelationships)
required
object (PersonRelationship)
400

Bad Request

401

Invalid authentication credentials

403

Not authorized to perform this operation

404

Resource was not found

500

Unexpected error occured

get/rest/accounts/{account_id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    • "id": "2bc7d781-3247-46f6-b60f-4090d214936a",
    • "type": "accounts",
    • "attributes": {
      • "verification_status": "VERIFIED",
      • "balances": {
        • "available": 12000,
        • "current": 50000,
        • "currency": "USD"
        },
      • "capabilities": {
        • "transfer_destination": [
          • {
            },
          • {
            }
          ]
        },
      • "name": "Debit Card",
      • "account_type": "CARD",
      • "subtype": "DEBIT",
      • "details": {
        • "first_name": "Edith",
        • "last_name": "Clarke",
        • "expiration_month": "02",
        • "expiration_year": "2025",
        • "last_four": "0003",
        • "issuer": "411600"
        }
      },
    • "links": {},
    • "relationships": {
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
}
Get a list of Account objects
Returns a list of account objects. An account object represents a person's bank accounts, debit and pay cards, and earnings balance accounts.
See Filtering Accounts for a description of filterable fields.


Securityoauth_user_token or oauth_client_credentials_token 
Request 
query Parameters
filter
string
  Examples: 
filter=person_id:"aa860051-c411-4709-9685-c1b716df611b"
header Parameters
DailyPay-API-Version
integer
 Default:  3
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.


 
 Example:  3
Accept
required
string
The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format.  For more details, see https://jsonapi.org.


 
 Value:  "application/vnd.api+json"
Responses 
200
Returns the account object.


Response Schema: application/vnd.api+json
required
Array of objects (AccountResource) 
 
 Array 
id
required
string <uuid> 
The unique identifier of the Account.


 
 Example:  "2bc7d781-3247-46f6-b60f-4090d214936a"
type
required
string
The type of the resource. Always accounts.


 
 Example:  "accounts"
 Value:  "accounts"
required
AccountAttributes_Card (object) or AccountAttributes_EarningsBalance (object) or AccountAttributes_Depository (object) (AccountAttributes) 
 
required
object (AccountLinks) 
 
required
object (AccountRelationships) 
 
400
Bad Request


401
Invalid authentication credentials


403
Not authorized to perform this operation


500
Unexpected error occured


get/rest/accounts
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "2bc7d781-3247-46f6-b60f-4090d214936a",
      • "type": "accounts",
      • "attributes": {
        • "verification_status": "VERIFIED",
        • "balances": {
          • "available": 12000,
          • "current": 50000,
          • "currency": "USD"
          },
        • "capabilities": {
          • "transfer_destination": [
            ]
          },
        • "name": "Debit Card",
        • "account_type": "CARD",
        • "subtype": "DEBIT",
        • "details": {
          • "first_name": "Edith",
          • "last_name": "Clarke",
          • "expiration_month": "02",
          • "expiration_year": "2025",
          • "last_four": "0003",
          • "issuer": "411600"
          }
        },
      • "links": {},
      • "relationships": {
        • "person": {
          • "data": {
            }
          }
        }
      }
    ]
}
Create an Account object
Create an account object to store a person's bank or card information as a destination for funds.


Securityoauth_user_token 
Request 
header Parameters
DailyPay-API-Version
integer
 Default:  3
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.


 
 Example:  3
Accept
required
string
The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format.  For more details, see https://jsonapi.org.


 
 Value:  "application/vnd.api+json"
Request Body schema: application/vnd.api+json
required
required
object (AccountResource) 
 
type
required
string
The type of the resource. Always accounts.


 
 Example:  "accounts"
 Value:  "accounts"
required
AccountAttributes_Card (object) or AccountAttributes_EarningsBalance (object) or AccountAttributes_Depository (object) (AccountAttributes) 
 
One of:
The details of the account.


name
string
Display name for this account.


 
 Example:  "Debit Card"
account_type
required
string
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).


 
 Value:  "CARD"
subtype
required
string
The subtype of the account.


 Enum: "DEBIT" "GALILEO" "WISELY"  
 Example:  "DEBIT"
required
subtype: DEBIT (object) or subtype: GALILEO (object) or subtype: WISELY (object)
The banking details of the account and account holder.


 
required
object (AccountRelationships) 
 
required
object (PersonRelationship) 
 
Responses 
200
Returns the account object.


Response Schema: application/vnd.api+json
required
object (AccountResource) 
 
id
required
string <uuid> 
The unique identifier of the Account.


 
 Example:  "2bc7d781-3247-46f6-b60f-4090d214936a"
type
required
string
The type of the resource. Always accounts.


 
 Example:  "accounts"
 Value:  "accounts"
required
AccountAttributes_Card (object) or AccountAttributes_EarningsBalance (object) or AccountAttributes_Depository (object) (AccountAttributes) 
 
One of:
The details of the account.


verification_status
required
string
A code that indicates the status of an account that is a destination for funds.


 Enum: "VERIFICATION_PENDING" "VERIFICATION_FAILED" "VERIFIED"  
 Example:  "VERIFIED"
required
object
 
required
object
 
name
string
Display name for this account.


 
 Example:  "Debit Card"
account_type
required
string
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).


 
 Value:  "CARD"
subtype
required
string
The subtype of the account.


 Enum: "DEBIT" "GALILEO" "WISELY"  
 Example:  "DEBIT"
required
subtype: DEBIT (object) or subtype: GALILEO (object) or subtype: WISELY (object)
The banking details of the account and account holder.


 
required
object (AccountLinks) 
 
self
required
string <uri>  (AccountLink) 
The URI for the account


 
required
object (AccountRelationships) 
 
required
object (PersonRelationship) 
 
401
Invalid authentication credentials


403
Not authorized to perform this operation


422
Unprocessable entity


500
Unexpected error occured


post/rest/accounts
Request samples 
application/vnd.api+json
{
  • "data": {
    • "type": "accounts",
    • "id": "2bc7d781-3247-46f6-b60f-4090d214936a",
    • "attributes": {
      • "name": "Acme Bank Checking Account",
      • "account_type": "DEPOSITORY",
      • "subtype": "CHECKING",
      • "details": {
        • "first_name": "Edith",
        • "last_name": "Clarke",
        • "routing_number": "XXXXX2021",
        • "account_number": "XXXXXX4321"
        }
      },
    • "relationships": {
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    • "id": "2bc7d781-3247-46f6-b60f-4090d214936a",
    • "type": "accounts",
    • "attributes": {
      • "verification_status": "VERIFIED",
      • "balances": {
        • "available": 12000,
        • "current": 50000,
        • "currency": "USD"
        },
      • "capabilities": {
        • "transfer_destination": [
          • {
            },
          • {
            }
          ]
        },
      • "name": "Debit Card",
      • "account_type": "CARD",
      • "subtype": "DEBIT",
      • "details": {
        • "first_name": "Edith",
        • "last_name": "Clarke",
        • "expiration_month": "02",
        • "expiration_year": "2025",
        • "last_four": "0003",
        • "issuer": "411600"
        }
      },
    • "links": {},
    • "relationships": {
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
}
➔ Next to Transfers