Platform accounts

Update platform

Updates a RippleNet platform, which represents a financial entity that holds accounts in the real world (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node.

put/config/platforms/{platform_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/:platform_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

platform_idstring uuid required

ID of the platform you want to update.

Request body

namestring

Name of the platform.

platform_type'WALLET_PROVIDER' | 'FIAT_INSTITUTION' | 'DIGITAL_EXCHANGE'

The type of institution this platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

descriptionstring

A short description of the platform.

institutionstring

Name of the institution this platform represents.

servicer_codestring

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

Response

Successfully updated RippleNet platform.

platform_idstring uuid

Unique identifier for the RippleNet platform.

namestring

Name of the RippleNet platform.

platform_type'WALLET_PROVIDER' | 'FIAT_INSTITUTION' | 'DIGITAL_EXCHANGE'

The type of institution this RippleNet platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

descriptionstring

A short description of the RippleNet platform.

institutionstring

Name of the institution this RippleNet platform represents.