SequenceSequence
Transfers
GET/transfers/{id}

Returns a single transfer record by ID. The transfer's source or destination account must be 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

Path Parameters

id*string

The transfer 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/transfers/string"

{
  "request_id": "req_01HABC1111",
  "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"
  }
}

{
  "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": "Transfer with id 'txr_123' was not found."
  }
}

List transfers GET

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.

List card transactions GETv2

Returns transactions for a specific card, ordered by `created_at` descending. Includes purchases (debits) and refunds (credits). The card's linked account ID must be present in the token's `READ_CARDS` resources.