v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Platform accounts

Create platform account

Creates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node.

post/config/platforms/accounts

Request body

namestring required

Name of the platform account.

platform_idstring uuid required

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring

A short description of the platform account.

external_account_idstring required

Unique reference identifier for the real world account which is represented by this platform account.

currencystring required

The currency of the account. Ripple recommends using ISO-4217 currency codes.

Response

Successfully created RippleNet platform account.

platform_account_idstring uuid

Unique identifier for the platform account.

namestring

Name of the platform account.

platform_idstring uuid

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring

A short description of the platform account.

external_account_idstring

Unique reference identifier for the real world account which is represented by this platform account.

currencystring

The currency of the account. Ripple recommends using ISO-4217 currency codes.

balancenumber

Real world account balance of the platform account (if available)