Skip to content

Create platform account

Request

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.

Security
Bearer
Bodyapplication/jsonrequired
namestringrequired

Name of the platform account.

platform_idstring, (uuid)required

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

descriptionstring, <= 512 characters

A short description of the platform account.

external_account_idstringrequired

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

currencystring, <= 3 charactersrequired

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

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/config/platforms/accounts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
    "description": "string",
    "external_account_id": "string",
    "currency": "str"
  }'

Responses

Successfully created RippleNet platform account.

Bodyapplication/json
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, <= 512 characters

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)

Response
{
  "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
  "name": "string",
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "description": "string",
  "external_account_id": "string",
  "currency": "string",
  "balance": 0
}