Skip to content

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.

EnvironmentDomaing PrefixDomainBase URL
Testaperture.testripplexcurrent.comhttps://aperture.test.ripplexcurrent.com
UATaperture.uatripplexcurrent.comhttps://aperture.uat.ripplexcurrent.com
Productionaperture.prodripplexcurrent.comhttps://aperture.prod.ripplexcurrent.com
Languages
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

Check health

Request

Gets the health status of the xCurrent server.

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

Responses

Successful response.

Bodyapplication/json
healthybooleanrequired

If set to true, the xCurrent server is up and running. If set to false, the xCurrent server is down.

Example: true
servicesArray of objects

List of services and their statuses returned by the health check.

servicestring

Name of the service.

Example: "database"
healthyboolean

Returns true if the service is up and running, and false if it is down or unreachable.

detailstring

Reason for health check failure, if any.

Example: "Message queue unreachable."
detailstring

Reason for health check failure, if any.

Example: "Failed to perform health check"
Response
application/json
{
  "healthy": true,
  "services": [
    { … }
  ],
  "detail": "Failed to perform health check"
}

Check heartbeat

Request

Gets the health status of the xCurrent server's peers. This request requires authorization. The timeout for this operation is 5 seconds.

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

Responses

Successful response.

Bodyapplication/json
time_checkedstring(date)required

Time at which the heartbeat was checked, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01"
xcurrent_nodestringrequired

RippleNet address of the RippleNet server for which the heartbeat was checked. (Deprecated in favor of 'ripplenet_node' field, has exactly the same value).

Example: "rn.us.ny.new_york"
ripplenet_nodestring

RippleNet address of the RippleNet server for which the heartbeat was checked.

Example: "rn.us.ny.new_york"
peer_heartbeat_resultsobjectrequired

Provides a list of peer RippleNet addresses and their health statuses.

property name*stringadditional property
Enum"HEALTHY""UNHEALTHY"
errorsArray of stringsrequired

If applicable, provides one or more messages describing the error.

Response
application/json
{
  "time_checked": "2019-10-01",
  "xcurrent_node": "rn.us.ny.new_york",
  "ripplenet_node": "rn.us.ny.new_york",
  "peer_heartbeat_results": {
    "property1": "HEALTHY",
    "property2": "HEALTHY"
  },
  "errors": [
    "string"
  ]
}

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

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