Accounts

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.

get/rest/accounts/{account_id}

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.

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.