ROOKDocs
GET

List internal transfers

ENDPOINT/v1/internal-transfers

Lists transactions of type INTERNAL_TRANSFER; equivalent to GET /v1/transactions?type=INTERNAL_TRANSFER. Returns internal movements between financial accounts in the program, newest first. Filter by source, destination, either-side financial account, category, and lifecycle status. This operation is program-scoped.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.

Query Parameters

ParameterTypeRequirementDescription
financial_account_idstring(uuid)OPTIONAL
Return only internal transfers where this financial account is the source or the destination.
from_financial_account_idstring(uuid)OPTIONAL
Return only internal transfers debited from this financial account.
to_financial_account_idstring(uuid)OPTIONAL
Return only internal transfers credited to this financial account.
statusstringOPTIONAL
Return only internal transfers in this lifecycle status.
Allowed:PENDINGSETTLEDDECLINEDVOIDEDEXPIREDRETURNEDREVERSEDRELEASEDCANCELED
categorystringOPTIONAL
Return only internal transfers in this category.
Allowed:ADJUSTMENTBALANCE_OR_FUNDINGFEEREWARDPROGRAM_FUNDINGTRANSFER
pageintegerOPTIONAL
1-based page index. Default 1. Values below 1 are treated as 1.
page_sizeintegerOPTIONAL
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_bystringOPTIONAL
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`, …).
ascendingbooleanOPTIONAL
Sort direction. Default true (ascending). Pass `false` for descending. Invalid values are ignored and the default is used.

Response Codes & Schemas

200A page of internal transfers.
application/json
{
  "data": [
    {
      "id": "5c8e1b39-0d6f-4a12-b9e4-4f7a2c8d3465",
      "object": "transaction",
      "type": "INTERNAL_TRANSFER",
      "status": "SETTLED",
      "transfer_ids": [
        "6f2d8a41-3c7e-4b95-a1d0-8e5c2f7b9a63"
      ],
      "amount": {
        "amount": 50000,
        "currency": "USD"
      },
      "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
      "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "direction": "DEBIT",
      "category": "TRANSFER",
      "memo": "Internal transfer to operating",
      "events": [
        {
          "id": "7d3f1a50-2e68-4b91-c4d7-1a9e6f0b3842",
          "type": "CREATED",
          "amount": {
            "amount": 50000,
            "currency": "USD"
          },
          "result": "APPROVED",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "created_at": "2026-08-26T18:40:00Z"
        },
        {
          "id": "9e4a2b61-3f79-4c02-d5e8-2b0f7a1c4953",
          "type": "SETTLED",
          "amount": {
            "amount": 50000,
            "currency": "USD"
          },
          "result": "APPROVED",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "created_at": "2026-08-26T18:40:05Z"
        }
      ],
      "created_at": "2026-08-26T18:40:00Z",
      "updated_at": "2026-08-26T18:40:05Z",
      "from_financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "to_financial_account_id": "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056",
      "subtype": "COLLECTION",
      "result": "APPROVED"
    }
  ],
  "total_count": 1
}
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"
  }
}