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.2.0, at version 4.0.0.
Requests are made against a single base URL, //[domainPrefix].ripplexcurrent.com/v4.
16 operations15 paths38 schemas1 DELETE4 GET10 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1
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 (Bearer).
By default, every request must be authenticated.
Bearer — All operations require a Bearer access token in the Authorization header of each request. Learn about [authentication](/products/payments-odl/api-docs/ripplene…
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
getPayments27 params→ 200400
GET
/payments/{payment_id}
Get payment by payment ID
getPaymentByPaymentId1 param→ 200400404
POST
/payments/{payment_id}/lock
Lock payment
lockPayment1 parambody→ 200400404
POST
/payments/{payment_id}/reject
Reject lock payment
rejectLockPayment1 parambody→ 200400404
POST
/payments/{payment_id}/retry_accept
Retry accept payment
retryAcceptPayment1 parambody→ 200400404
POST
/payments/{payment_id}/fail
Fail payment
failPayment1 parambody→ 200400404
POST
/payments/{payment_id}/settle
Settle payment
settlePayment1 parambody→ 200400404409
POST
/payments/{payment_id}/finalize
Finalize payment
finalizePayment1 parambody→ 200400404
POST
/payments/{payment_id}/sub_state
Add payment sub state
addPaymentSubState1 parambody→ 200400404
POST
/payments/{payment_id}/complete
Complete payment
completePayment1 parambody→ 200400404
PUT
/payments/{payment_id}/labels
Add payment labels
addPaymentLabels2 params→ 200400404
DELETE
/payments/{payment_id}/labels
Delete payment labels
deletePaymentLabels2 params→ 200400404
GET
/payments/{payment_id}/node-status
Get payment node status
getPaymentNodeStatus1 param→ 200400404
GET
/payments/filtered/{payment_id}
Get filtered payment by payment ID
getFilteredPaymentByPaymentId1 param→ 200400404
POST
/quote_collections/return
Create quote to return payment
createQuoteToReturnPaymentbody→ 200400404500
POST
/quote_collections/reversal
Create quote to reverse payment
createQuoteToReversePaymentbody→ 200400404500
Schemas 38
The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are ExecutionResult (21 properties), BasePayment (16 properties), Quote (16 properties), QuoteElement (13 properties). Each schema is shown below with its type and property counts.
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
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 properties3 required
PaymentLockRequest
object
Use this JSON request object to lock a payment.
2 properties
FeeInfo
object
Itemized list of fees charged by each node.
2 properties2 required
UserInfo
object
User information provided across the payment lifecycle.
13 properties13 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 properties2 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 properties12 required
Label
object
Label object
1 property
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
LiquidationDetails
object
Payment liquidation details
4 properties
PaymentSettleRequest
object
Use this JSON request object to begin payment settlement.
1 property
FXRate
object
The details of an FX Rate for a quote or payment.
4 properties4 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 properties2 required
RippleNetInfoEntry
object
Application-generated information explaining an action taken by a RippleNet application
2 properties
UserInfoEntry
object
User information provided as arbitrary key/value pairs.
3 properties2 required
Page
object
Paginated response base object.
8 properties
PaymentDenyRequest
object
Use this JSON request object to fail a payment or reject a request to lock a payment.
1 property1 required
QuoteError
object
Object that describes an error that happened during quote collection.
3 properties2 required
FeeDetails
object
4 properties3 required
TotalFees
object
2 properties2 required
RippleNetInfo
object
Application-generated information explaining actions taken by RippleNet applications.
2 properties2 required
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 properties4 required
PaymentReversalQuoteRequest
object
Use this JSON request object to generate a collection of quotes that can be used to reverse a payment.
2 properties2 required
UserInfoArray
object
1 property
PaymentCompleteRequest
object
Use this JSON request object to complete a payment
1 property
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 properties10 required
PaymentReturnQuoteRequest
object
Use this JSON request object to generate a collection of quotes that can be used to return a payment.
7 properties1 required
Quote
object
JSON response object that represents a quote for a proposed payment or return payment.
16 properties13 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 properties2 required
QuotePathRos
object
Object that describes a liquidity path used to generate a quote.
6 properties4 required
Sort
object
6 properties
PaymentQuoteCustomRateRequest
object
JSON request object to specify a custom exchange rate during quote collection generation.
4 properties4 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 properties4 required
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
PaymentReversalReason
object
A structured object detailing reasons for a payment reversal.
2 properties1 required
FilteredPayment
object
A sanitized payment with sensitive content filtered from the userinfo object.
Payments
Paged response for payments includes:
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 properties9 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Ripple Labs Non-orchestration payments API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
