GET

Retrieve a loan tape

ENDPOINT/v1/loan-tapes/{loan_tape_id}

Returns a single daily wallet-level ledger snapshot by id, including outstanding balances by bucket (principal, interest, fees), net day totals, delinquency standing, and minimum payment. 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
loan_tape_id	string	REQUIRED	Unique identifier of the loan tape snapshot.

Response Codes & Schemas

200The requested loan tape snapshot.

application/json

{
  "id": "5d9a2c14-7f8e-4b63-91d0-3a6c1e5b2469",
  "object": "loan_tape",
  "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
  "program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "as_of": "2026-08-26",
  "balances": {
    "principal": {
      "amount": 432150,
      "currency": "USD"
    },
    "interest": {
      "amount": 1875,
      "currency": "USD"
    },
    "fees": {
      "amount": 500,
      "currency": "USD"
    }
  },
  "day_totals": {
    "principal": {
      "amount": 12500,
      "currency": "USD"
    },
    "interest": {
      "amount": 62,
      "currency": "USD"
    },
    "fees": {
      "amount": 0,
      "currency": "USD"
    }
  },
  "delinquency": {
    "state": "CURRENT",
    "days_past_due": 0,
    "amount_past_due": {
      "amount": 0,
      "currency": "USD"
    }
  },
  "minimum_payment": {
    "amount": 2500,
    "currency": "USD"
  },
  "created_at": "2026-08-27T05:05:00Z",
  "updated_at": "2026-08-27T05:05:00Z"
}

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"
  }
}