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

Get audits

Request

Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance.

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 payments to return per page.

Default 10
beforestring

Filters for audit events where the range_field value is before this specified time stamp (not inclusive). You can also specify after to create a time range between after and before. If before is specified, range_field must also be specified.

afterstring

Filters for audit events where the range_field value is after this specified time stamp (not inclusive). You can also specify before to create a time range between after and before. If after is specified, range_field must also be specified.

range_fieldstring

Filters payments before/after/between created and modified timestamps (CREATED_AT, MODIFIED_AT). For example, if you specify range_field=CREATED_AT, you would specify a timestamp (in the 24-character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in payment objects) as the value for before and/or after to fetch audit events before, after, or between the specified time range(s) (not inclusive). If range_field is specified, before and/or after must also be specified.

actorstring

Filters for audit events based upon actor.

actionstring

Filters for audit events based upon action.

levelstring

Filters for audit events based upon audit level.

Enum"INFO""WARN""ERROR"
domainstring

Filters for audit events based upon audit domain.

Enum"USER_MANAGEMENT""CONFIG_MANAGEMENT""OTHER"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/audit?page=0&size=10&before=string&after=string&range_field=string&actor=string&action=string&level=INFO&domain=USER_MANAGEMENT' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful response

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
actorstring

Person or middleware who took the action.

Example: "super_user_client"
actionstring

Action that triggered the event.

Example: "KEY_UPDATE"
eventIdstring(uuid)

UUID representing the event.

Example: "3d5d0831-762c-4e0c-980c-635b38fd9caf"
messagestring

Message describing the audit event.

Example: "Added public key class PublicKeyRecord {\n publicKey: MCowBQYDK2VwAyEAb8Q2YzrbTIwrUn7u5Q6hJimp7jBFHx500MfDM4XVNJ0=\n keyIntent: SIGNING_PUBLIC_KEY\n keyType: ED_25519\n keyVersion: 1\n expiryDateTime: 2089-09-23T17:27:50.331Z\n} for RippleNet address rn.us.ny.new_york"
metadatastring

Information about the event, such as IP Address and URI.

Example: "{\"ip\":\"0:0:0:0:0:0:0:1\",\"uri\":\"/internal/key_service/addresses/rn.us.ny.new_york/keys\"}"
domainstring

Represents the audit event domain.

Enum"USER_MANAGEMENT""CONFIG_MANAGEMENT""OTHER"
Example: "CONFIG_MANAGEMENT"
levelstring

Represents the audit event level.

Enum"INFO""WARN""ERROR"
Example: "INFO"
timeStampstring

Timestamp of the audit event.

Example: "2019-09-30T22:55:41.365000Z"
Response
application/json
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}

Get event trail for payment

Request

Gets an audit trail of a payment's state changes on a local RippleNet instance.

Security
Bearer
Path
idstring(uuid)required

Unique identifier of a payment.

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

Responses

Payment state change event trail.

Bodyapplication/jsonArray [
featureNamestring

Feature name associated with the entityId. Possible values are payment.

Example: "payment"
eventDetailstring

Detailed description of the event.

Example: "Updated Payment to state PREPARED"
entityIdstring(uuid)

UUID representing an event.

Example: "d485f100-2af7-4e48-9ab1-3c7e28775691"
messageActionstring

String representation of the action being taken, where DS = downstream and US = upstream in the messaging processing pipeline.

Enum"DS_STARTED""DS_COMPLETED""US_STARTED""US_COMPLETED""STATE_CHANGE""FAILURE"
Example: "STATE_CHANGE"
createdAtstring

Timestamp of the audit event.

Example: "2019-10-01T18:24:28.040000Z"
messageSenderstring(RippleNetAddress)

The RippleNetAddress of the originator of the message that triggered the creation of this event.

Example: "default"
messageTypestring

The type of message that was being processed that triggered the creation of this event.

Example: "SETTLEMENT_PREPARE"
]
Response
application/json
[
  {
    "featureName": "payment",
    "eventDetail": "Updated Payment to state PREPARED",
    "entityId": "d485f100-2af7-4e48-9ab1-3c7e28775691",
    "messageAction": "STATE_CHANGE",
    "createdAt": "2019-10-01T18:24:28.040000Z",
    "messageSender": "default",
    "messageType": "SETTLEMENT_PREPARE"
  }
]

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

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