Ramp: List transactions

← transaction operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation ramp.get_transactions_canonical_list_with_pagination

Provider route: GET /developer/v1/transactions. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";

async function execute(input: Parameters<RampIntegration["transaction"]["getTransactionsCanonicalListWithPagination"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.transaction.getTransactionsCanonicalListWithPagination(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.transaction.get_transactions_canonical_list_with_pagination(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.sk_category_id	integer	Optional	One of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
query.department_id	string	Optional	Format: uuid
query.limit_id	string	Optional	Format: uuid
query.location_id	string	Optional	Format: uuid
query.merchant_id	string	Optional	Format: uuid
query.card_id	string	Optional	Format: uuid
query.spend_program_id	string	Optional	Format: uuid
query.statement_id	string	Optional	Format: uuid
query.approval_status	string	Optional	One of: AWAITING_EMPLOYEE, AWAITING_EMPLOYEE_CHANGES_REQUESTED, AWAITING_EMPLOYEE_MISSING_ITEMS, AWAITING_EMPLOYEE_REPAYMENT_FAILED, AWAITING_EMPLOYEE_REPAYMENT_REQUESTED, AWAITING_REVIEWER, FULLY_APPROVED
query.state	string	Optional	One of: ALL, CLEARED, COMPLETION, DECLINED, ERROR, PENDING, PENDING_INITIATION
query.user_id	string	Optional	Format: uuid
query.awaiting_approval_by_user_id	string	Optional	Format: uuid
query.sync_status	string	Optional	One of: NOT_SYNC_READY, SYNCED, SYNC_READY
query.has_been_approved	boolean	Optional
query.all_requirements_met_and_approved	boolean	Optional
query.has_statement	boolean	Optional
query.synced_after	string	Optional	Format: date-time
query.min_amount	JSON	Optional
query.min_amount (oneOf 1)	string	Alternative	Format: decimal
query.min_amount (oneOf 2)	number	Alternative
query.has_no_sync_commits	boolean	Optional
query.max_amount	JSON	Optional
query.max_amount (oneOf 1)	string	Alternative	Format: decimal
query.max_amount (oneOf 2)	number	Alternative
query.from_date	string	Optional	Format: date-time
query.to_date	string	Optional	Format: date-time
query.trip_id	string	Optional	Format: uuid
query.accounting_field_selection_id	string	Optional	Format: uuid
query.entity_id	string	Optional	Format: uuid
query.requires_memo	boolean	Optional
query.include_count	boolean	Optional	Default: false
query.include_merchant_data	boolean	Optional
query.order_by_date_asc	boolean	Optional
query.order_by_date_desc	boolean	Optional
query.order_by_amount_asc	boolean	Optional
query.order_by_amount_desc	boolean	Optional
query.start	string	Optional
query.page_size	integer	Optional	Default: 20

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List transactions — response body

Referenced models: List transactions — response body

Policy, approvals and errors

SDK function policy ID: ramp.get_transactions_canonical_list_with_pagination. Catalog operation: get_transactions_canonical_list_with_pagination. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["transactions:read"]

Official provider source