Platform accounts

Update platform account

Updates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider).

put/config/platforms/accounts/{platform_account_id}

Request

Base URL
//[domainPrefix].ripplexcurrent.com/v4 (relative, and it does not resolve against the document’s source URL)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ripple/apis/ripplenet-server-api/docs/config/platforms/accounts/:platform_account_id/put.ts
A function with typed inputs. Its response is checked against the schema.

platform_account_idstring uuid required

ID of the platform account you want to update.

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.

Successfully updated RippleNet platform account.

platform_account_idstring uuid

Unique identifier for the platform account.