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

Exchange transfers

Operations

Fees

Operations

Liquidation configuration

Operations

Non-orchestration payments

Operations

Notifications

Operations

Get notifications by status and priority

Request

Get notification entities by notification status and priority

Security
Bearer
Query
pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.<br/> Set it to 0 to get the first page of results.

Default 0
sizeinteger[ 1 .. 100 ]

Number of notification objects to return per page.

Default 10
notification_statusstring

Status of ripplenet notifications.

Default "DELIVERED"
Enum"CREATED""DELIVERED""READ""DELETED"
notification_prioritystring

Priority of ripplenet notifications.

Default "ALL"
Enum"ALL""ERROR""INFO""WARN"
sort_fieldstring

describes how to sort the results.

Default "CREATED_DTTM"
Enum"CREATED_DTTM""MODIFIED_DTTM"
sort_directionstring

Direction of sorted results.

Default "ASC"
Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/notifications?page=0&size=10&notification_status=CREATED&notification_priority=ALL&sort_field=CREATED_DTTM&sort_direction=ASC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned notifications for the request

Bodyapplication/json
firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger(int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

directionstring

Direction of the sort

Example: "ASC"
propertystring
ignoreCaseboolean
nullHandlingstring
Example: "NULLS_FIRST"
ascendingboolean
Example: true
descendingboolean
Example: false
contentArray of objects
notification_idstring(uuid)required

Notification Id

notification_typestringrequired

Context in which the notification is generated

Enum"HEARTBEAT_EVENT""NEW_PEERING_EVENT""NEW_LIQUIDITY_RELATIONSHIP_EVENT""LOW_BALANCE_EVENT"
notification_statusstringrequired

Status of the notification

Enum"CREATED""DELIVERED""READ""DELETED"
notification_prioritystringrequired

Priority of the notification

Enum"ERROR""INFO""WARN"
created_atstring(date-time)required

Date and time at which the notification was created, as an ISO-8601 timestamp in UTC.

entity_typestringrequired

RippleNet entity for which the notification has been generated

Enum"QUOTE""PAYMENT""TRANSFER""EXCHANGE"
entity_idstring(uuid)required

Entity id of the RippleNet entity for which the notification has been generated

message_detailsstringrequired

Summary description of the notification

source_addressstring

RippleNet address of the host that has created the notification

destination_addressstring

RippleNet address of the host that needs to receive the notification

notification_detailsstring

Payload of the notification object

Response
application/json
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}

Get notification by ID

Request

Get Notification entity by notification id.

Security
Bearer
Path
notification_idstring(uuid)required

NotificationId

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/notifications/{notification_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned Notification for the request

Bodyapplication/json
notification_idstring(uuid)required

Notification Id

notification_typestringrequired

Context in which the notification is generated

Enum"HEARTBEAT_EVENT""NEW_PEERING_EVENT""NEW_LIQUIDITY_RELATIONSHIP_EVENT""LOW_BALANCE_EVENT"
notification_statusstringrequired

Status of the notification

Enum"CREATED""DELIVERED""READ""DELETED"
notification_prioritystringrequired

Priority of the notification

Enum"ERROR""INFO""WARN"
created_atstring(date-time)required

Date and time at which the notification was created, as an ISO-8601 timestamp in UTC.

entity_typestringrequired

RippleNet entity for which the notification has been generated

Enum"QUOTE""PAYMENT""TRANSFER""EXCHANGE"
entity_idstring(uuid)required

Entity id of the RippleNet entity for which the notification has been generated

message_detailsstringrequired

Summary description of the notification

source_addressstring

RippleNet address of the host that has created the notification

destination_addressstring

RippleNet address of the host that needs to receive the notification

notification_detailsstring

Payload of the notification object

Response
application/json
{
  "notification_id": "f96afe21-aef9-465c-a9f6-813055655b04",
  "notification_type": "HEARTBEAT_EVENT",
  "notification_status": "CREATED",
  "notification_priority": "ERROR",
  "created_at": "2019-08-24T14:15:22Z",
  "entity_type": "QUOTE",
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "message_details": "string",
  "source_address": "string",
  "destination_address": "string",
  "notification_details": "string"
}

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