Platform accounts

Use these operations to configure your RippleNet platform accounts.

Operation	Method	Description
Create platform	POST	Creates a RippleNet platform that represents a financial entity that holds accounts in the real world. For example, a Bank, Exchange, or Wallet provider.
Get all platforms	GET	Returns a list of all active RippleNet platforms.
Get platform by platform ID	GET	Get a RippleNet platform by its platform ID.
Update platform	PUT	Updates a RippleNet platform.
Delete platform by platform ID	DELETE	Deletes a RippleNet platform by its platform ID.
Create platform account	POST	Creates a RippleNet platform account, which represents a real-world account owned by a financial entity.
Get platform accounts	GET	Returns a paged list of all active RippleNet platform accounts.
Get platform account by platform account ID	GET	Gets a RippleNet platform account by its platform account ID.
Update platform account	PUT	Updates a RippleNet platform account.
Delete platform account by platform account ID	DELETE	Deletes a RippleNet platform account by its platform account ID.
Get platform accounts balances	GET	Get balances for local Platform Accounts
Get platform account statement	GET	Get statement for a specified Platform Account

Operações

Create platform

Requisição

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.

Segurança

Bearer

Corpoapplication/jsonobrigatório

namestringobrigatório

Name of the platform.

platform_typestringobrigatório

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.

institutionstringobrigatório

Name of the institution this platform represents.

servicer_codestringobrigatório

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

curl -i -X POST \
  https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/config/platforms \
  -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"
  }'

Respostas

Successfully created RippleNet platform.

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

Resposta

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