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.
RippleNet Server API (4.0.0)
All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.
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 |
Languages
Servers
Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet
https://[domainPrefix].ripplexcurrent.com/v4
- Mock serverhttps://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/info
- https://[domainPrefix].ripplexcurrent.com/v4/v4/orchestration/info
- curl
- Python
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'Response
application/json
{ "name": "Integration Module", "version": "1.2.0" }
- Mock serverhttps://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/internal/payment/{uniqueReferenceNumber}
- https://[domainPrefix].ripplexcurrent.com/v4/v4/orchestration/internal/payment/{uniqueReferenceNumber}
- curl
- Python
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/internal/payment/{uniqueReferenceNumber}' \
-H 'Authorization: YOUR_API_KEY_HERE'Successfully returned orchestration payment.
Unique Identifier of the orchestration payment.
Example: "5492648d-2132-4e70-9ded-2fc86f22b321"
Payment ID for the transaction in RippleNet.
Example: "26bf269b-1a2b-c3d4-872a-7f18d7dcf9f2"
Template name used for executing the orchestration payment.
Example: "default_template"
Date and time at which the orchestration payment was created, as an ISO-8601 timestamp in UTC.
Example: "2018-04-06T20:33:35Z"