Skip to content

Update platform

Request

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.

Security
Bearer
Path
platform_idstring, (uuid)required

ID of the platform you want to update.

Bodyapplication/jsonrequired
namestring

Name of the platform.

platform_typestring

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

Enum:"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring, <= 512 characters

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

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/config/platforms/{platform_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_type": "WALLET_PROVIDER",
    "description": "string",
    "institution": "string",
    "servicer_code": "string"
  }'

Responses

Successfully updated RippleNet platform.

Bodyapplication/json
platform_idstring, (uuid)

Unique identifier for the RippleNet platform.

namestring

Name of the RippleNet platform.

platform_typestring

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

Enum:"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring, <= 512 characters

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

Response
{
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "name": "string",
  "platform_type": "WALLET_PROVIDER",
  "description": "string",
  "institution": "string",
  "servicer_code": "string"
}