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 Transactions API

Used to manage transactions

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

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

14 operations 14 paths 44 schemas 5 GET6 POST3 PUT

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 Transactions 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 14

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

Transactions 14

Used to manage transactions

GET
/v2/transactions
List transactions
TransactionsService_ListTransactions 102 params → 200400401403404default
POST
/v2/transactions/transfer/estimate-fee
Estimate the fee for a transfer transaction
TransactionsService_EstimateTransferFee body → 200400401403404default
POST
/v2/transactions:list
List transactions
TransactionsService_ListTransactions2 body → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}/transactions
List wallet transactions
TransactionsService_ListWalletTransactions 107 params → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets/{walletId}/transactions/raw
Create a new raw transaction
TransactionsService_RawTransaction 2 params body → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets/{walletId}/transactions/sign-plaintext
(BETA) Create a new sign plaintext transaction
TransactionsService_SignPlaintext 2 params body → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets/{walletId}/transactions/transfer
Create a new transfer transaction
TransactionsService_TransferTransaction 2 params body → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}
Get a transaction
TransactionsService_GetTransaction 3 params → 200400401403404default
PUT
/v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}/freeze
Freeze a transaction
TransactionsService_FreezeTransaction 4 params → 200400401403404default
PUT
/v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}/unfreeze
Unfreeze a transaction
TransactionsService_UnfreezeTransaction 4 params → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets/{walletId}/transactions:list
List wallet transactions
TransactionsService_ListWalletTransactions2 2 params body → 200400401403404default
GET
/v1/stablecoin/transactions
List transactions
listTransactions 5 params → 200400401403500
GET
/v1/stablecoin/transactions/{id}
Get a transaction
getTransaction 1 param → 200401403404500
PUT
/v1/stablecoin/transactions/{id}/destination
Approve a pending redemption
updateTransactionDestination 1 param body → 200400401403404409500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are transactionsv2Transaction (37 properties), commonv2Asset (19 properties), v2TransactionFilter (13 properties), v2NumericFilter (9 properties). Each schema is shown below with its type and property counts.

transactionsv2Transaction
object
37 properties 16 required
TransactionListResponse
object
5 properties
v2TransactionStatusFilter
object
4 properties
ProblemDetail
object
Error response following RFC 9457 (Problem Details for HTTP APIs), the successor to RFC 7807.
4 properties
commonv2Asset
object
19 properties 5 required
transactionsv2Address
object
5 properties 2 required
v2XRPTransactionConfig
object
2 properties
v2Standard
string
transactionsv2AddressType
string
protobufAny
object
1 property
v2TransactionActionFilter
object
4 properties
v2ListWalletTransactionsResponse
object
2 properties
TimestampFilterTimestampRange
object
2 properties
v2FreezeType
string
v2TimestampFilter
object
9 properties
TransactionEndpoint
object
6 properties 1 required
v2FreezeHistoryEntry
object
8 properties
v2FreezeInfo
object
2 properties
v2SigningPayload
object
4 properties 2 required
v2AssetSource
string
v2AssetChangePurpose
string
v2FilterResponse
object
3 properties 1 required
UpdateTransactionDestination
object
Approval payload for a PENDING (flexible redemption) transaction. FIAT directs the redemption to your default bank account (creates a REDEMPTION); CRYPTO bridg…
2 properties 1 required
v2EvmFeeEstimate
object
4 properties 4 required
v2Blockchain
string
v2FeeEstimate
object
2 properties 1 required
v2NumericFilter
object
9 properties
v2EstimateTransferFeeRequest
object
5 properties 3 required
v2ListTransactionsRequest
object
3 properties
v2Problem
object
6 properties
v2Retryability
string
v2AssetChange
object
5 properties 3 required
v2TransactionFilter
object
13 properties
v2FreezeAction
string
transactionsv2TransactionAction
string
v2StringFilter
object
8 properties
Transaction
object
9 properties 7 required
v2SortOrder
string
v2ListTransactionsResponse
object
2 properties
v2BlockchainFilter
object
4 properties
v2AssetChangeWallet
object
4 properties 1 required
v2FilterRequest
object
4 properties
transactionsv2TransactionStatus
string
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-transactions-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 Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API