Skip to content

Ramp: Banking schemas

6 Ramp schemas with complete fields and constraints.

← Banking operations · All schemas

Get balance history for a banking account — response body

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

Referenced models: List bills — response body — page, Get balance history for a banking account — response body — data item

Get balance history for a banking account — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Hold Bill — response body — amount
Available balance and currency for the account on this date
datestringRequired within parentDate of the account balance
Format: date

Referenced models: Hold Bill — response body — amount

List banking accounts — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List banking accounts — 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 banking accounts — response body — data item

List banking accounts — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
account_typestringRequired within parentType of financial account (WALLET_ACCOUNT, BROKERAGE_ACCOUNT, MANAGED_PORTFOLIO_ACCOUNT)
Known values: BROKERAGE_ACCOUNT, MANAGED_PORTFOLIO_ACCOUNT, WALLET_ACCOUNT
idstringRequired within parentIdentifier of the treasury account
Format: uuid
namestringRequired within parentName of the treasury account

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

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.