Ramp: Banking schemas
6 Ramp schemas with complete fields and constraints.
← Banking operations · All schemas
Get balance history for a banking account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Get balance history for a banking account — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Available balance and currency for the account on this date |
date | string | Required within parent | Date of the account balance Format: date |
Referenced models: Hold Bill — response body — amount
List banking accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List banking accounts — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_type | string | Required within parent | Type of financial account (WALLET_ACCOUNT, BROKERAGE_ACCOUNT, MANAGED_PORTFOLIO_ACCOUNT) Known values: BROKERAGE_ACCOUNT, MANAGED_PORTFOLIO_ACCOUNT, WALLET_ACCOUNT |
id | string | Required within parent | Identifier of the treasury account Format: uuid |
name | string | Required within parent | Name of the treasury account |
List syncable banking transactions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List syncable banking transactions — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Transaction amount and currency |
date | string | Required within parent | Date when the transaction was initiated Format: date-time |
description | string | Required within parent | Description signifying the type of transfer |
destination_account_name | JSON | Required within parent | |
destination_account_name (anyOf 1) | string | Alternative | Destination account for the transaction |
destination_account_name (anyOf 2) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Business entity this treasury transaction is associated with Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the treasury transaction Format: uuid |
source_account_name | JSON | Required within parent | |
source_account_name (anyOf 1) | string | Alternative | Source account for the transaction |
source_account_name (anyOf 2) | null | Alternative | |
sync_status | string | Required within parent | Synchronization status of the treasury transaction Known values: NOT_SYNC_READY, SYNCED, SYNC_READY |
treasury_transfer_type | string | Required within parent | Type of treasury transfer Known values: BROKERAGE_ORDER, MANAGED_PORTFOLIO_ACTIVITY, MANAGED_PORTFOLIO_TRANSFER, WALLET_TRANSFER |
Referenced models: Hold Bill — response body — amount