Ripple Labs Platform accounts API
Use these operations to configure your RippleNet platform accounts.| Operation | Method | Description || -- | -- | -- || [Create platform](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/createplatform) | POST | Creates a RippleNet platform that represents a financial entity that holds accounts in the real world. For example, a Bank, Exchange, or Wallet provider. || [Get all platforms](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getallplatforms) | GET | Returns a list of all active RippleNet platforms. || [Get platform by platform ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformbyplatformid) | GET | Get a RippleNet platform by its platform ID. || [Update platform](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/updateplatform) | PUT | Updates a RippleNet platform. || [Delete platform by platform ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/deleteplatformbyplatformid) | DELETE | Deletes a RippleNet platform by its platform ID. || [Create platform account](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/createplatformaccount) | POST | Creates a RippleNet platform account, which represents a real-world account owned by a financial entity. || [Get platform accounts](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccounts) | GET | Returns a paged list of all active RippleNet platform accounts. || [Get platform account by platform account ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountbyplatformaccountid) | GET | Gets a RippleNet platform account by its platform account ID. || [Update platform account](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/updateplatformaccount) | PUT | Updates a RippleNet platform account. || [Delete platform account by platform account ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/deleteplatformaccountbyplatformaccountid) | DELETE | Deletes a RippleNet platform account by its platform account ID. || [Get platform accounts balances](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountsbalances) | GET | Get balances for local Platform Accounts || [Get platform account statement](/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountstatement) | GET | Get statement for a specified Platform Account |
Ripple Labs Platform accounts API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Platform accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 12 operations across 6 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2.0.
Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs Platform accounts API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (TokenAuth).
By default, every request must be authenticated.
Paths & Operations 12
Across 6 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Use these operations to configure your RippleNet platform accounts. | Operation | Method | Description | | -- | -- | -- | | [Create platform](/products/payments-odl/api-docs/rippl…
Schemas 16
The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are StatementRecord (15 properties), Transactions (9 properties), StatementResponse (9 properties), Page (8 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.