RippleNet Server API (4.0.0)

The RippleNet Server API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.

Check out the best practices and tutorials.

Authentication

All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.

API environments

The RippleNet Server API creates a dynamic [domainPrefix] that consists of {tenant}.{environment}.

Note: This example uses aperture as the tenant. Your tenant ID is different.

Environment	Domaing Prefix	Domain	Base URL
Test	`aperture.test`	`ripplexcurrent.com`	`https://aperture.test.ripplexcurrent.com`
UAT	`aperture.uat`	`ripplexcurrent.com`	`https://aperture.uat.ripplexcurrent.com`
Production	`aperture.prod`	`ripplexcurrent.com`	`https://aperture.prod.ripplexcurrent.com`

Servers

Mock server

https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/

https://[domainPrefix].ripplexcurrent.com/v4/

Account configuration

Operations

Auditing

Operations

Balances and statements

Operations

Beneficiary confirmation

Operations

Diagnostics

Operations

Exchange transfers

Operations

Fees

Operations

Liquidation configuration

Operations

Non-orchestration payments

Operations

Notifications

Operations

ODL flags configuration

Operations

Orchestration payments

Operations

Payment expiration

Operations

Payout method

Operations

Platform accounts

Operations

Pool accounts

Operations

Quote expiration

Operations

Quotes

Operations

Rates

Operations

Request for payment

Operations

Sender segregated account configuration

Operations

Transfers

Operations

schema

Operations

activity

Operations

Orchestration Template

Operations

Add an orchestration template

Request

Adds an orchestration template with a unique name.

Security

Bearer

Bodyapplication/jsonrequired

namestring[ 1 .. 64 ] characters^[a-zA-Z0-9_-]*$required

Name of the orchestration template. It must start with 'custom'.

Example: "custom_orchestration_template_v1"

payment_typestringrequired

The payment type for which the template is to be used.

Enum"REGULAR""RETURN""ACCEPT""REVERSAL"

connector_rolestringrequired

The connector role for which the template is to be used.

Enum"SENDING""RECEIVING""INTERMEDIARY"

default_templateboolean

Is orchestration template default.

Default false

Example: true

orchestration_template_descriptionstring<= 256 characters^[a-zA-Z0-9@_,.:\s-]*$

Orchestration template description.

Default ""

activity_orderArray of objectsnon-emptyrequired

Activity order list.

activity_namestring[ 1 .. 64 ] characters^[a-zA-Z0-9_]*$required

Activity name.

Example: "activity_v1"

next_activityArray of objectsrequired

Next activity based on current activity status.

statusstringrequired

Activity status

Enum"SUCCESS""FAILURE""DECLINED""REDO""SUBSTATE""NOTIFY""SUBTASK"

activity_namestring[ 1 .. 64 ] characters^[a-zA-Z0-9_]*$required

Activity name.

Example: "activity_v1"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/template \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "custom_orchestration_template_v1",
    "payment_type": "REGULAR",
    "connector_role": "SENDING",
    "default_template": true,
    "orchestration_template_description": "",
    "activity_order": [
      {
        "activity_name": "activity_v1",
        "next_activity": [
          {
            "status": "SUCCESS",
            "activity_name": "activity_v1"
          }
        ]
      }
    ]
  }'

Responses

Successfully created orchestration template.

Bodyapplication/json

namestring<= 64 charactersrequired

Orchestration template name.

Example: "custom_orchestration_template_v1"

payment_typestring

The payment type for which the template is to be used.

Enum"REGULAR""RETURN""REVERSAL"

connector_rolestring

The connector role for which the template is to be used.

Enum"SENDING""RECEIVING""INTERMEDIARY"

default_templateboolean

Is orchestration template default.

Default false

Example: true

orchestration_template_descriptionstring<= 255 characters

Orchestration template description.

activity_orderArray of objectsrequired

Activity order list.

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

next_activityArray of objectsrequired

Next activity based on current activity status.

statusstringrequired

Activity status

Enum"SUCCESS""FAILURE""DECLINED""REDO""SUBSTATE""NOTIFY""SUBTASK"

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

Response

application/json

{
  "name": "custom_orchestration_template_v1",
  "payment_type": "REGULAR",
  "connector_role": "SENDING",
  "default_template": true,
  "orchestration_template_description": "string",
  "activity_order": [
    { … }
  ]
}

Get all orchestration templates

Request

Gets a list of configured orchestration templates.

Security

Bearer

curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/template \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned list of orchestration templates.

Bodyapplication/jsonArray [

namestring<= 64 charactersrequired

Orchestration template name.

Example: "custom_orchestration_template_v1"

payment_typestring

The payment type for which the template is to be used.

Enum"REGULAR""RETURN""REVERSAL"

connector_rolestring

The connector role for which the template is to be used.

Enum"SENDING""RECEIVING""INTERMEDIARY"

default_templateboolean

Is orchestration template default.

Default false

Example: true

orchestration_template_descriptionstring<= 255 characters

Orchestration template description.

activity_orderArray of objectsrequired

Activity order list.

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

next_activityArray of objectsrequired

Next activity based on current activity status.

statusstringrequired

Activity status

Enum"SUCCESS""FAILURE""DECLINED""REDO""SUBSTATE""NOTIFY""SUBTASK"

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

]

Response

application/json

[
  {
    "name": "custom_orchestration_template_v1",
    "payment_type": "REGULAR",
    "connector_role": "SENDING",
    "default_template": true,
    "orchestration_template_description": "string",
    "activity_order": [ … ]
  }
]

Get orchestration template by Name

Request

Gets a configured orchestration template by its name.

Security

Bearer

Path

namestring(String)<= 64 charactersrequired

The name of the orchestration template you want to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/template/{name}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned orchestration template.

Bodyapplication/json

namestring<= 64 charactersrequired

Orchestration template name.

Example: "custom_orchestration_template_v1"

payment_typestring

The payment type for which the template is to be used.

Enum"REGULAR""RETURN""REVERSAL"

connector_rolestring

The connector role for which the template is to be used.

Enum"SENDING""RECEIVING""INTERMEDIARY"

default_templateboolean

Is orchestration template default.

Default false

Example: true

orchestration_template_descriptionstring<= 255 characters

Orchestration template description.

activity_orderArray of objectsrequired

Activity order list.

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

next_activityArray of objectsrequired

Next activity based on current activity status.

statusstringrequired

Activity status

Enum"SUCCESS""FAILURE""DECLINED""REDO""SUBSTATE""NOTIFY""SUBTASK"

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

Response

application/json

{
  "name": "custom_orchestration_template_v1",
  "payment_type": "REGULAR",
  "connector_role": "SENDING",
  "default_template": true,
  "orchestration_template_description": "string",
  "activity_order": [
    { … }
  ]
}

Change default_template value of the orchestration template

Request

Changes default_template value of the orchestration template.

Security

Bearer

Path

namestring(String)<= 64 charactersrequired

The name of the orchestration template you want to retrieve.

Bodyapplication/jsonrequired

default_templatebooleanrequired

Is orchestration template default.

Default false

Example: true

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/template/{name}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "default_template": true
  }'

Responses

Successfully created orchestration template.

Bodyapplication/json

namestring<= 64 charactersrequired

Orchestration template name.

Example: "custom_orchestration_template_v1"

payment_typestring

The payment type for which the template is to be used.

Enum"REGULAR""RETURN""REVERSAL"

connector_rolestring

The connector role for which the template is to be used.

Enum"SENDING""RECEIVING""INTERMEDIARY"

default_templateboolean

Is orchestration template default.

Default false

Example: true

orchestration_template_descriptionstring<= 255 characters

Orchestration template description.

activity_orderArray of objectsrequired

Activity order list.

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

next_activityArray of objectsrequired

Next activity based on current activity status.

statusstringrequired

Activity status

Enum"SUCCESS""FAILURE""DECLINED""REDO""SUBSTATE""NOTIFY""SUBTASK"

activity_namestring<= 64 charactersrequired

Activity name.

Example: "activity_v1"

Response

application/json

{
  "name": "custom_orchestration_template_v1",
  "payment_type": "REGULAR",
  "connector_role": "SENDING",
  "default_template": true,
  "orchestration_template_description": "string",
  "activity_order": [
    { … }
  ]
}

diagnostics

Operations

payment

Operations

Get application info

Request

Gets application information.

Security

Bearer

curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched application info.

Bodyapplication/json

namestring

Application name.

Example: "Integration Module"

versionstring

Application version.

Example: "1.2.0"

Response

application/json

{
  "name": "Integration Module",
  "version": "1.2.0"
}

tenant

Operations

Orchestration internal action

Operations

Orchestration internal payments

Operations

Orchestration internal notifications

Operations

RippleNet Server API (4.0.0)

Authentication

API environments

Account configuration

Auditing

Balances and statements

Beneficiary confirmation

Diagnostics

Exchange transfers

Fees

Liquidation configuration

Non-orchestration payments

Notifications

ODL flags configuration

Orchestration payments

Payment expiration

Payout method

Platform accounts

Pool accounts

Quote expiration

Quotes

Rates

Request for payment

Sender segregated account configuration

Transfers

schema

activity

Orchestration Template

Add an orchestration template

RequestExpand all

Responses

Was this page helpful?

Get all orchestration templates

Request

Responses

Was this page helpful?

Get orchestration template by Name

Request

Responses

Was this page helpful?

Change default_template value of the orchestration template

Request

Responses

Was this page helpful?

diagnostics

payment

Get application info

Request

Responses

Was this page helpful?

tenant

Orchestration internal action

Orchestration internal payments

Orchestration internal notifications

Request