GET

List book transfers

ENDPOINT/v1/financial-accounts/{financial_account_id}/book-transfers

Returns the book transfers posted to this financial account's books, newest first. A book transfer is the collection of balanced book entries (debits and credits) that one transfer of a transaction posts; each item carries its entries, including legs on other financial accounts when the transfer crossed them. Filter by book, transfer_id, or transaction_id to reconcile one movement. This operation is program-scoped.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.

Path Parameters

Parameter	Type	Requirement	Description
financial_account_id	string	REQUIRED	Unique identifier of the financial account.

Query Parameters

Parameter	Type	Requirement	Description
book	string	OPTIONAL	Return only book transfers with at least one book entry in this book, for example `principal`.
transfer_id	string(uuid)	OPTIONAL	Return only the book transfer posted by this transfer.
transaction_id	string(uuid)	OPTIONAL	Return only book transfers posted by transfers of this transaction.
page	integer	OPTIONAL	1-based page index. Default 1. Values below 1 are treated as 1.
page_size	integer	OPTIONAL	Number of objects to return in the page. Minimum 1, maximum 100, default 10. Also accepted as `page-size`. Values below 1 fall back to the default; values above 100 are capped at 100.
order_by	string	OPTIONAL	Field to sort by. When omitted, the endpoint uses its default order. Also accepted as `order-by`. Valid fields are endpoint-specific (`created_at`, `updated_at`, …).
ascending	boolean	OPTIONAL	Sort direction. Default true (ascending). Pass `false` for descending. Invalid values are ignored and the default is used.

Response Codes & Schemas

200A page of book transfers, each with its book entries.

application/json

{
  "data": [
    {
      "id": "7c1e9a24-5b3d-4f60-a8e2-1d6f3b9c0a57",
      "object": "book_transfer",
      "transfer_id": "0d9c3b52-7e14-4a68-b2f5-1c6e8d0a3f47",
      "transaction_id": "9a1e5c73-2b48-4d06-8f3a-7c5b0e2d4a19",
      "amount": {
        "amount": 120,
        "currency": "USD"
      },
      "financial_account_ids": [
        "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14"
      ],
      "entries": [
        {
          "book": "interest",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "entry_type": "DEBIT",
          "amount": {
            "amount": 120,
            "currency": "USD"
          }
        },
        {
          "book": "interest_income",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "entry_type": "CREDIT",
          "amount": {
            "amount": 120,
            "currency": "USD"
          }
        }
      ],
      "posted_at": "2026-08-28T02:00:00Z"
    },
    {
      "id": "3b7f1d92-6a04-4c58-8e2b-9d1c5f7a0e63",
      "object": "book_transfer",
      "transfer_id": "6f2d8a41-3c7e-4b95-a1d0-8e5c2f7b9a63",
      "transaction_id": "2b5f7a28-9c4d-4e01-a6f3-1d8e0b7c2354",
      "amount": {
        "amount": 4280,
        "currency": "USD"
      },
      "financial_account_ids": [
        "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
        "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056"
      ],
      "entries": [
        {
          "book": "principal",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "entry_type": "DEBIT",
          "amount": {
            "amount": 4280,
            "currency": "USD"
          }
        },
        {
          "book": "unallocated",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "entry_type": "CREDIT",
          "amount": {
            "amount": 4280,
            "currency": "USD"
          }
        },
        {
          "book": "settlement_payable",
          "financial_account_id": "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056",
          "entry_type": "DEBIT",
          "amount": {
            "amount": 4280,
            "currency": "USD"
          }
        },
        {
          "book": "cash",
          "financial_account_id": "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056",
          "entry_type": "CREDIT",
          "amount": {
            "amount": 4280,
            "currency": "USD"
          }
        }
      ],
      "posted_at": "2026-08-27T15:04:05Z"
    }
  ],
  "total_count": 2
}

400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}

401Unauthorized: missing, malformed, or unknown API key.

application/json

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}

403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.

application/json

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}

404Not Found: unknown id, or the resource is not visible to this API key.

application/json

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}

429Too Many Requests: the API key exceeded its rate limit.

application/json

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}

500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.

application/json

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}