DAdailypay
Accounts

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.

get/rest/accounts

Request

  • Base URL
    https://api.dailypay.com
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://auth.dailypay.com/oauth2/token
      Scopesclient:lookup, client:admin
    • or OAuth 2
      Authorization codehttps://auth.dailypay.com/oauth2/auth
      Token URLhttps://auth.dailypay.com/oauth2/token
      Scopesuser:read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

filter[person.id]string uuid
Example:aa860051-c411-4709-9685-c1b716df611b

Limit the results to documents related to a specific person

filter[account_type]'EARNINGS_BALANCE' | 'DEPOSITORY' | 'CARD'
Example:EARNINGS_BALANCE

Limit the results to documents matching the specified account type.

filter[subtype]string
Example:ODP

Limit the results to documents matching the specified account subtype.

filterstring

Response

Returns the account object.

Example response

{
  "data": [
    {
      "id": "2bc7d781-3247-46f6-b60f-4090d214936a",
      "type": "accounts",
      "attributes": {
        "verification_status": "VERIFIED",
        "balances": {
          "available": 12000,
          "current": 50000,
          "currency": "USD"
        },
        "capabilities": {
          "transfer_destination": [
            {
              "schedule": "WITHIN_THIRTY_MINUTES",
              "fee": 300,
              "currency": "USD"
            },
            {
              "schedule": "NEXT_BUSINESS_DAY",
              "fee": 0,
              "currency": "USD"
            }
          ]
        },
        "name": "Debit Card",
        "subtype": "DEBIT",
        "details": {
          "last_four": "0003",
          "issuer": "411600",
          "first_name": "Edith",
          "last_name": "Clarke",
          "expiration_month": "02",
          "expiration_year": "2025"
        }
      },
      "links": {
        "self": "https://api.dailypay.com/rest/accounts/2bc7d781-3247-46f6-b60f-4090d214936a"
      },
      "relationships": {
        "person": {
          "data": {
            "type": "people",
            "id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.