Ripple Labs Non-orchestration payments API
Ripple Labs Non-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 Non-orchestration payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 16 operations across 15 paths, and defines 38 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.
16 operations
15 paths
38 schemas
1 DELETE4 GET10 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs Non-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 16
Across 15 paths, the API surfaces 16 operations — 1 DELETE, 4 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Non-orchestration payments 16
GET
/payments
Get payments
GET
/payments/{payment_id}
Get payment by payment ID
POST
/payments/{payment_id}/lock
Lock payment
POST
/payments/{payment_id}/reject
Reject lock payment
POST
/payments/{payment_id}/retry_accept
Retry accept payment
POST
/payments/{payment_id}/fail
Fail payment
POST
/payments/{payment_id}/settle
Settle payment
POST
/payments/{payment_id}/finalize
Finalize payment
POST
/payments/{payment_id}/sub_state
Add payment sub state
POST
/payments/{payment_id}/complete
Complete payment
PUT
/payments/{payment_id}/labels
Add payment labels
DELETE
/payments/{payment_id}/labels
Delete payment labels
GET
/payments/{payment_id}/node-status
Get payment node status
GET
/payments/filtered/{payment_id}
Get filtered payment by payment ID
POST
/quote_collections/return
Create quote to return payment
POST
/quote_collections/reversal
Create quote to reverse payment
Schemas 38
The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are ExecutionResult (21 properties), Quote (16 properties), BasePayment (16 properties), UserInfo (13 properties). Each schema is shown below with its type and property counts.
Sort
object
6 properties
PaymentRetryAcceptRequest
object
Use this JSON request object to move a payment from LOCKDENIED state back to ACCEPTED state, making it available for locking by intermediaries and the receiver.
1 property
QuoteElement
object
JSON object that provides transfer and exchange elements used to provide the quote. A transfer element represents the transfer of currency between two accounts…
13 properties
9 required
PaymentFinalizeRequest
object
Use this JSON request object to mark a payment with finalized sub-states that reflect what is happening to the payment while it is in the EXECUTED state.
2 properties
2 required
TotalFees
object
2 properties
2 required
PaymentReturnQuoteRequest
object
Use this JSON request object to generate a collection of quotes that can be used to return a payment.
7 properties
1 required
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
FilteredPayment
object
A sanitized payment with sensitive content filtered from the userinfo object.
Quote
object
JSON response object that represents a quote for a proposed payment or return payment.
16 properties
13 required
PaymentSettleRequest
object
Use this JSON request object to begin payment settlement.
1 property
QuotePathRos
object
Object that describes a liquidity path used to generate a quote.
6 properties
4 required
ExecutionResult
object
Represents the actual movement of funds in a payment. Each execution result corresponds to a quote element and represents its execution in a payment. Included…
21 properties
10 required
RippleNetInfo
object
Application-generated information explaining actions taken by RippleNet applications.
2 properties
2 required
PaymentDenyRequest
object
Use this JSON request object to fail a payment or reject a request to lock a payment.
1 property
1 required
PaymentQuoteCustomRateRequest
object
JSON request object to specify a custom exchange rate during quote collection generation.
4 properties
4 required
Payment
JSON response object that represents a payment. A payment is the movement of value across accounts on potentially different RippleNet instances involving one o…
3 required
InternalInfo
object
JSON object containing information that only the RippleNet instance that set it can view. These values can be set by the sender when accepting a payment and by…
3 properties
3 required
LiquidationDetails
object
Payment liquidation details
4 properties
QuoteError
object
Object that describes an error that happened during quote collection.
3 properties
2 required
PaymentReversalQuoteRequest
object
Use this JSON request object to generate a collection of quotes that can be used to reverse a payment.
2 properties
2 required
QuoteCollection
object
When provided as a response to the [Create quote collection](operation/createQuoteCollection) request, provides a JSON object representing quotes for a propose…
3 properties
2 required
PaymentReversalReason
object
A structured object detailing reasons for a payment reversal.
2 properties
1 required
NodeStatus
object
An array of objects that provide the following field values describing the state of a payment on each node participating in the payment.
4 properties
4 required
UserInfo
object
User information provided across the payment lifecycle.
13 properties
13 required
UserInfoEntry
object
User information provided as arbitrary key/value pairs.
3 properties
2 required
PaymentSubStateRequest
object
Use this JSON request object to mark a payment with finalized sub-states that reflect what is happening to the payment while it is in the EXECUTED state.
3 properties
2 required
RippleNetInfoEntry
object
Application-generated information explaining an action taken by a RippleNet application
2 properties
PaymentContract
object
Represents all immutable parts of a payment agreed upon by all participants as a part of the [Lock payment](operation/lockPayment) flow. Once a payment transit…
5 properties
4 required
BasePayment
object
JSON response object that represents a payment. A payment is the movement of value across accounts on potentially different RippleNet instances involving one o…
16 properties
12 required
Payments
Paged response for payments includes:
PaymentLockRequest
object
Use this JSON request object to lock a payment.
2 properties
FeeInfo
object
Itemized list of fees charged by each node.
2 properties
2 required
Label
object
Label object
1 property
FXRate
object
The details of an FX Rate for a quote or payment.
4 properties
4 required
Page
object
Paginated response base object.
8 properties
FeeDetails
object
4 properties
3 required
UserInfoArray
object
1 property
PaymentCompleteRequest
object
Use this JSON request object to complete a payment
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.
Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
#Non-orchestration payments