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

Ripple Labs Exchange transfers API

Use these operations to manage exchange transfers.| Operation | Method | Description || -- | -- | -- || [Get exchange transfers](/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransfers) | GET | List all exchange transfers. || [Execute exchange transfer](/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/executeexchangetransfer) | POST | Execute an exchange transfer to move funds from one of your accounts in one currency, to another one of your accounts in another currency. || [Get exchange transfer quote ](/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransferquote) | POST | Requests a quote for an exchange transfer. || [Complete exchange transfer ](/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/completeexchangetransfer) | POST | Updates the status of an exchange transfer to `COMPLETED`. Make this request once the exchange transfer has been made on both the ledger and on internal systems. || [Get exchange transfer by ID ](/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransferbyid) | GET | Gets an exchange transfer by ID. |

Ripple Labs Exchange transfers 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 Exchange transfers. 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 10 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 10 schemas 2 GET3 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 Exchange transfers 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 — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Exchange transfers 5

Use these operations to manage exchange transfers. | Operation | Method | Description | | -- | -- | -- | | [Get exchange transfers](/products/payments-odl/api-docs/ripplenet/refer…

GET
/exchange_transfers
Get exchange transfers
getExchangeTransfers 2 params → 200400
POST
/exchange_transfers/execute
Execute exchange transfer
executeExchangeTransfer body → 200400
POST
/exchange_transfers/quote
Get exchange transfer quote
getExchangeTransferQuote body → 200400
POST
/exchange_transfers/{id}/complete
Complete exchange transfer
completeExchangeTransfer 1 param → 200404
GET
/exchange_transfers/{id}
Get exchange transfer by ID
getExchangeTransferById 1 param → 200404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are FiatExchangeTransferExecuteResponse (13 properties), FiatExchangeTransferQuoteResponse (8 properties), Page (8 properties), FiatExchangeTransferExecuteRequest (7 properties). Each schema is shown below with its type and property counts.

Sort
object
6 properties
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
ExchangeTransferRate
object
Describes an exchange rate used in an exchange transfer.
4 properties 4 required
FiatExchangeTransferQuoteResponse
object
JSON response object that represents a quote for an exchange transfer.
8 properties 8 required
FiatExchangeTransferUserInfo
object
Custom information about an exchange transfer provided by a RippleNet address involved in the exchange transfer.
4 properties 3 required
Page
object
Paginated response base object.
8 properties
FiatExchangeTransferExecuteRequest
object
JSON request object to execute an exchange transfer.
7 properties 4 required
ExchangeTransfers
object
Provides a content array of exchange transfer objects and a set of pagination information fields.
FiatExchangeTransferExecuteResponse
object
JSON response object that represents an exchange transfer.
13 properties 13 required
FiatExchangeTransferQuoteRequest
object
Use this JSON request body to request a quote for an exchange transfer.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-exchange-transfers-api-openapi.yml Raw ↑

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 Fees API
Ripple Labs Liquidations API
Ripple Labs Market Cap API