Skip to content

Ramp: List syncable banking transactions

Ramp banking.getTreasuryTransactionsResource: arguments, response, policy and SDK examples.

← Banking operations · Get started

Operation ramp.get_treasury_transactions_resource

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

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["banking"]["getTreasuryTransactionsResource"]>[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.banking.getTreasuryTransactionsResource(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.banking.get_treasury_transactions_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.entity_idsJSONOptional
query.entity_ids (anyOf 1)arrayAlternative
query.entity_ids (anyOf 1)[]stringEach itemFormat: uuid
query.entity_ids (anyOf 2)nullAlternative
query.start_datestringOptionalFormat: date-time
query.end_datestringOptionalFormat: date-time
query.include_synced_transfersbooleanOptionalDefault: false
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List syncable banking transactions — response body

Referenced models: List syncable banking transactions — response body

List syncable banking transactions — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List syncable banking transactions — response body — data item
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, List syncable banking transactions — response body — data item

List bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
List syncable banking transactions — response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Hold Bill — response body — amount
Transaction amount and currency
datestringRequired within parentDate when the transaction was initiated
Format: date-time
descriptionstringRequired within parentDescription signifying the type of transfer
destination_account_nameJSONRequired within parent
destination_account_name (anyOf 1)stringAlternativeDestination account for the transaction
destination_account_name (anyOf 2)nullAlternative
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeBusiness entity this treasury transaction is associated with
Format: uuid
entity_id (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the treasury transaction
Format: uuid
source_account_nameJSONRequired within parent
source_account_name (anyOf 1)stringAlternativeSource account for the transaction
source_account_name (anyOf 2)nullAlternative
sync_statusstringRequired within parentSynchronization status of the treasury transaction
Known values: NOT_SYNC_READY, SYNCED, SYNC_READY
treasury_transfer_typestringRequired within parentType of treasury transfer
Known values: BROKERAGE_ORDER, MANAGED_PORTFOLIO_ACTIVITY, MANAGED_PORTFOLIO_TRANSFER, WALLET_TRANSFER

Referenced models: Hold Bill — response body — amount

Hold Bill — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativethe amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_codestringRequired within parentThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information.
Read only: true
minor_unit_conversion_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative

SDK function policy ID: ramp.get_treasury_transactions_resource. Catalog operation: get_treasury_transactions_resource. 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: ["treasury:read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.