Ripple Labs Transfers API
Use these operations to manage your transfers.| Operation | Method | Description || -- | -- | -- || [Get transfers](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransfers) | GET | Gets a list of transfers. || [Get transfer estimate](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransferestimate) | GET | Get an estimate of the fee to make an "outbound" transfer from an exchange (connected to xRapid) to an another account outside of RippleNet (such as a bank account). || [Get transfer by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransferbyid) | GET | Gets a transfer by ID. || [Execute transfer](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/executetransfer) | POST | Transfers funds between accounts. || [Complete transfer](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/completetransfer) | POST | Updates the state of a transfer to `COMPLETED`. || [Add transfer labels](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/addtransferlabels) | PUT | Adds a list of labels to the transfer. To retrieve transfers by label, see [Get transfers](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransfers) || [Delete transfer labels](/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/deletetransferlabels) | DELETE | Deletes one or more existing labels from the transfer. |
Ripple Labs 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 Transfers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 7 operations across 6 paths, and defines 7 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs 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 7
Across 6 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Use these operations to manage your transfers. | Operation | Method | Description | | -- | -- | -- | | [Get transfers](/products/payments-odl/api-docs/ripplenet/reference/openapi/…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TransferResponse (12 properties), Page (8 properties), TransferRequest (7 properties), RippleNetProblem (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.