SequenceSequence
Accounts
GET/accounts/{id}

Returns the full account including masked account details and current balance. The requested account ID must be present in the token's READ_ACCOUNTS resources.

AuthorizationClick to expand
ApiKeyAuth
Authorization<token>

Format: ApiKey <key>. Keys are scoped to an organization and carry explicit permissions.

Each key holds a list of permission entries. An entry specifies a scope and a resources constraint. A request returns 403 if the key lacks the required scope, or if the requested resource is outside the key's allowed list.

ScopeResourcesGrants access to
LIST_ACCOUNTSnoneList all accounts in the organization
READ_ACCOUNTSaccount IDs or *Full account details and balance for a specific account
LIST_RULESnoneList all rules in the organization
READ_RULESrule IDs or *Full rule details (steps, conditions, actions) for a specific rule
TRIGGER_RULESrule IDs or *Triggering rule executions
READ_RULE_EXECUTIONSrule IDs or *Rule execution history - rule_id filter required
READ_TRANSFERSaccount IDs or *Transfer history - account_id filter required
MANUAL_TRANSFERlist of { source, target, max_amount? } setsCreating manual transfers
READ_CARDSaccount IDs or *Cards and card transactions - account_id filter required

In: header

Path Parameters

id*string

The account ID.

Header Parameters

X-Request-ID?string

A client-provided request identifier echoed back in the response `X-Request-ID` header and `request_id` body field. If omitted, the server generates one.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.getsequence.io/api/v1/accounts/string"
{
  "request_id": "req_01HGHI7004",
  "data": {
    "id": "acc_01HGHI7890",
    "name": "Amex Gold ••1234",
    "type": "external_account",
    "description": null,
    "external_account_type": "LIABILITY",
    "beneficiary_name": "John Smith",
    "institution_name": "American Express",
    "can_be_source": false,
    "can_be_destination": true,
    "routing_number": "••••0021",
    "bank_account_number": "••••1234",
    "balance": {
      "balance_in_cents": 245000,
      "available_balance_in_cents": null,
      "last_statement_balance_in_cents": 198000,
      "next_payment_minimum_in_cents": 3500,
      "next_payment_due_date": "2024-05-15",
      "balance_last_updated_at": "2024-04-23T06:00:00Z"
    },
    "created_at": "2024-01-20T11:00:00Z",
    "updated_at": "2024-04-23T06:00:00Z"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission."
  }
}
{
  "error": {
    "code": "resource_not_found",
    "message": "Account with id 'acc_123' was not found."
  }
}