v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Platform accounts

Create platform

Creates 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.

post/config/platforms

Request body

namestring required

Name of the platform.

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

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

descriptionstring

A short description of the platform.

institutionstring required

Name of the institution this platform represents.

servicer_codestring required

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

Response

Successfully created 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.

servicer_codestring

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