Ripple Labs Orchestration payments API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orchestration payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
12 operations
across 11 paths,
and defines 20 schemas.
It is described by OpenAPI 3.0.0, at version 2.0.
Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.
12 operations11 paths20 schemas5 GET5 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1
Authentication & Security 1
Ripple Labs Orchestration payments API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (TokenAuth).
By default, every request must be authenticated.
Paths & Operations 12
Across 11 paths, the API surfaces 12 operations — 5 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are OrchestrationPaymentRequest (21 properties), OrchestrationPaymentResponse (18 properties), Page (8 properties), OrchestrationPaymentReturnRequest (8 properties). Each schema is shown below with its type and property counts.
Sort
object
6 properties
PaymentActionRequest
object
5 properties3 required
ActivityOutput
object
Use this object when notificationtype is PARTNERSUBSTATE. For all other values of notificationtype, this property can be null.
3 properties
OrchestrationPayments
PaymentCustomRateRequest
object
Custom rate that the return payment quotes must use.
4 properties4 required
NotificationUUIDList
object
JSON request object that represents a list of orchestration payment notification UUIDs to acknolwedge.
1 property
OrchestrationPaymentRequest
object
JSON request object that represents an orchestration payment.
21 properties7 required
OrchestrationPaymentAcceptRequest
object
JSON request object that represents an orchestration payment accept request.
5 properties3 required
OrchestrationPaymentReversalRequest
object
Use this JSON request object to reverse a payment.
3 properties3 required
NotificationResponseRos
object
JSON request object that represents an orchestration payment notification.
7 properties
OrchestrationPaymentSubmitResponse
object
JSON response object that represents an orchestration payment query ID.
