Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Ripple Labs

Ripple Labs Quotes API

Use these operations to manage your quotes.| Operation | Method | Description || -- | -- | -- || [Accept quote](/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/acceptquote) | POST | Accepts a quote ID to start the payment process. || [Get quotes](/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotes) | GET | Gets a list of quotes. || [Get quote by quote ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotebyquoteid) | GET | Gets a quote by ID. || [Create quote collection](/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/createquotecollection) | POST | Creates a collection of quotes for a proposed payment. || [Get quote collection by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotecollectionbyid) | GET | Gets a quote collection that was created for a proposed payment. |

Documentation Provider Profile APIs.io OpenAPI GitHub

Ripple Labs Quotes 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 Quotes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 5 paths, and defines 24 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.

5 operations 5 paths 24 schemas 3 GET2 POST

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 Quotes 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 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Quotes 5

Use these operations to manage your quotes. | Operation | Method | Description | | -- | -- | -- | | [Accept quote](/products/payments-odl/api-docs/ripplenet/reference/openapi/quot…

POST
/payments/accept
Accept quote
acceptQuote body → 200412
GET
/quotes
Get quotes
getQuotes 2 params → 200400
GET
/quotes/{quote_id}
Get quote by quote ID
getQuoteByQuoteId 1 param → 200400
POST
/quote_collections
Create quote collection
createQuoteCollection body → 200400
GET
/quote_collections/{quote_collection_id}
Get quote collection by ID
getQuoteCollectionById 1 param → 200400

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ExecutionResult (21 properties), PaymentQuoteRequest (17 properties), Quote (16 properties), BasePayment (16 properties). Each schema is shown below with its type and property counts.

PaymentQuoteRequest
object
JSON request object to generate a quote collection.
17 properties 5 required
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
TotalFees
object
2 properties 2 required
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
Quote
object
JSON response object that represents a quote for a proposed payment or return payment.
16 properties 13 required
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
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
PaymentQuoteCustomRateRequest
object
JSON request object to specify a custom exchange rate during quote collection generation.
4 properties 4 required
LiquidationDetails
object
Payment liquidation details
4 properties
QuoteError
object
Object that describes an error that happened during quote collection.
3 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
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
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
Label
object
Label object
1 property
FeeInfo
object
Itemized list of fees charged by each node.
2 properties 2 required
FXRate
object
The details of an FX Rate for a quote or payment.
4 properties 4 required
FeeDetails
object
4 properties 3 required
PaymentAcceptRequest
object
Use this JSON request object to accept a quote ID to start the payment process.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-quotes-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
AE Profile APIs.io
Ripple Labs API Credentials API
AE Profile APIs.io
Ripple Labs Auditing API
AE Profile APIs.io
Ripple Labs Authentication API
AE Profile APIs.io
Ripple Labs Balances and statements API
AE Profile APIs.io
Ripple Labs Balances API
AE Profile APIs.io
Ripple Labs Beneficiary confirmation API
AE Profile APIs.io
Ripple Labs Counterparties API
AE Profile APIs.io
Ripple Labs Diagnostics API
AE Profile APIs.io
Ripple Labs Exchange transfers API
AE Profile APIs.io
Ripple Labs Fees API
AE Profile APIs.io
Ripple Labs Liquidations API
AE Profile APIs.io
#Quotes
← Back to R APIs
API Details
ID
ripple-labs:ripple-labs-quotes-api
Base URL
https://api.ripple.com
Docs
https://docs.ripple.com/products/stablecoin/api/get-started
Provider
Ripple Labs
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network