SequenceSequence
Transfers
GET/transfers

Returns transfers for the organization, ordered by created_at descending. Credit card and debit card transactions are excluded. account_id is required and must be present in the token's READ_TRANSFERS 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

Query Parameters

account_id*string

Account ID to filter by. Must be present in the token's `READ_TRANSFERS` resources. Use `account_role` to control whether to match on source, destination, or either.

account_role?string, Value in "source" | "destination" | "either"

Controls how `account_id` is matched. Defaults to `either`. Ignored if `account_id` is not provided.

direction?string, Value in "money_in" | "money_out" | "internal"

Filter by direction.

origin?string, Value in "paycheck" | "check_deposit" | "cashback" | "user_pull" | "rule" | "user" | "external_pull"

Filter by origin.

status?string, Value in "pending_approval" | "processing" | "pending" | "complete" | "incomplete" | "error" | "cancelled"

Filter by status.

rule_execution_id?string

Filter by rule execution ID. Returns all transfers created by a specific execution.

from?string

Return transfers created at or after this timestamp (ISO 8601).

to?string

Return transfers created at or before this timestamp (ISO 8601).

first?integer

Number of results to return. Defaults to 20, maximum 100.

after?string

Cursor from a previous response's `page_info.end_cursor` to fetch the next page.

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

curl -X GET "https://api.getsequence.io/api/v1/transfers?account_id=string"
{
  "request_id": "req_01HABC9999",
  "data": [
    {
      "id": "txr_01HABC1111",
      "amount_in_cents": 100000,
      "direction": "internal",
      "origin": "rule",
      "status": "complete",
      "source": {
        "id": "acc_01HABC4567",
        "name": "Main Payroll",
        "type": "income_source"
      },
      "destination": {
        "id": "acc_01HDEF0123",
        "name": "Emergency Fund",
        "type": "pod"
      },
      "rule_id": "rule_01HXYZ1234",
      "rule_execution_id": "rex_01HABC4567",
      "error_code": null,
      "created_at": "2024-04-23T09:15:00Z",
      "completed_at": "2024-04-23T09:15:04Z"
    },
    {
      "id": "txr_01HDEF2222",
      "amount_in_cents": 500000,
      "direction": "money_in",
      "origin": "paycheck",
      "status": "complete",
      "source": null,
      "destination": {
        "id": "acc_01HABC4567",
        "name": "Main Payroll",
        "type": "income_source"
      },
      "rule_id": null,
      "rule_execution_id": null,
      "error_code": null,
      "created_at": "2024-04-23T09:00:00Z",
      "completed_at": "2024-04-23T09:00:00Z"
    },
    {
      "id": "txr_01HGHI3333",
      "amount_in_cents": 20000,
      "direction": "money_out",
      "origin": "external_pull",
      "status": "complete",
      "source": {
        "id": "acc_01HDEF0123",
        "name": "Emergency Fund",
        "type": "pod"
      },
      "destination": null,
      "rule_id": null,
      "rule_execution_id": null,
      "error_code": null,
      "created_at": "2024-04-22T18:45:00Z",
      "completed_at": "2024-04-22T18:45:00Z"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "cursor_01HGHI3333"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission."
  }
}

Create a manual transfer POST

Creates a manual transfer from a source account to a destination account. The transfer is processed asynchronously - poll `GET /transfers/{id}` to track status. The token must have a `MANUAL_TRANSFER` permission entry whose `source` matches `source_account_id` and `target` matches `destination_account_id`. If `max_amount` is set on the matching entry, the requested amount must not exceed it.

Get a transfer GET

Returns a single transfer record by ID. The transfer's source or destination account must be in the token's `READ_TRANSFERS` resources.