Skip to content

Get all platforms

Request

Returns a list of all active RippleNet platforms.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/config/platforms \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of all active RippleNet platforms.

Bodyapplication/json
Array [
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" } ]