How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 4.0.0.

Requests are made against a single base URL, //[domainPrefix].ripplexcurrent.com/v4.

12 operations 6 paths 16 schemas 2 DELETE6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

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 (Bearer). By default, every request must be authenticated.

  • Bearer — All operations require a Bearer access token in the Authorization header of each request. Learn about [authentication](/products/payments-odl/api-docs/ripplene…

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.

Platform accounts 12

Use these operations to configure your RippleNet platform accounts. | Operation | Method | Description | | -- | -- | -- | | [Create platform](/products/payments-odl/api-docs/rippl…

POST
/config/platforms
Create platform
createPlatform body → 200400
GET
/config/platforms
Get all platforms
getAllPlatforms → 200400
GET
/config/platforms/{platform_id}
Get platform by platform ID
getPlatformByPlatformId 1 param → 200400
PUT
/config/platforms/{platform_id}
Update platform
updatePlatform 2 params body → 200400
DELETE
/config/platforms/{platform_id}
Delete platform by platform ID
deletePlatformByPlatformId 2 params → 204400
POST
/config/platforms/accounts
Create platform account
createPlatformAccount body → 200400
GET
/config/platforms/accounts
Get platform accounts
getPlatformAccounts 2 params → 200400
GET
/config/platforms/accounts/{platform_account_id}
Get platform account by platform account ID
getPlatformAccountByPlatformAccountId 1 param → 200400
PUT
/config/platforms/accounts/{platform_account_id}
Update platform account
updatePlatformAccount 2 params body → 200400
DELETE
/config/platforms/accounts/{platform_account_id}
Delete platform account by platform account ID
deletePlatformAccountByPlatformAccountId 2 params → 204400
GET
/monitor/platform/accounts/balances
Get platform accounts balances
getPlatformAccountsBalances → 200400
GET
/monitor/platform/accounts/{platformAccountId}/statement
Get platform account statement
getPlatformAccountStatement 5 params → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are StatementRecord (15 properties), StatementResponse (9 properties), Transactions (9 properties), Page (8 properties). Each schema is shown below with its type and property counts.

StatementRecord
object
Provides details about a transaction included in an account statement.
15 properties 12 required
PlatformAccountsPage
Paged response for account lookups
StatementResponse
object
Provides a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
9 properties 9 required
PlatformAccountsBalances
object
Object representing list of platforms, their accounts and their respective balances
1 property
CreatePlatformAccountRequest
object
Request object for creating a Ripplenet platform account.
5 properties 4 required
CreatePlatformRequest
object
Request object for creating a RippleNet platform, which maps to a real world financial institution.
5 properties 4 required
PlatformAccountResponse
object
Response object for creating a Ripplenet platform account.
7 properties
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
UpdatePlatformAccountRequest
object
Request object for updating a Ripplenet platform account.
5 properties
Sort
object
6 properties
PlatformResponse
object
Response object for creating a Ripplenet platform, which maps to a real world financial institution.
6 properties
UpdatePlatformRequest
object
Request object for updating a RippleNet platform, which maps to a real world financial institution. Note: platformtype is set on the creation of the platform a…
5 properties
Page
object
Paginated response base object.
8 properties
PlatformAccountItem
object
Represents a Platform Account
7 properties
PlatformItem
object
Represents a Platform
6 properties
Transactions
object
Provides a content array of statement record objects and a set of pagination information fields.
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-platform-accounts-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
Where this information came from

This is an independent, third-party profile of Ripple Labs Platform accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.