How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Ripple Labs

Ripple Labs Orchestration payments API

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 12 operations across 11 paths, and defines 20 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.

12 operations 11 paths 20 schemas 5 GET5 POST2 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 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 12

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

Orchestration payments 12
POST
/v4/orchestration/payment
Create orchestration payment
createOrchestrationPayment body → 201
GET
/v4/orchestration/payment
Get orchestration payments
getOrchestrationPayments 9 params → 200
GET
/v4/orchestration/payment/{uniqueReferenceNumber}
Get orchestration payment
getOrchestrationPayment 1 param → 200
POST
/v4/orchestration/payment/return
Return orchestration payment
returnOrchestrationPayment body → 201
POST
/v4/orchestration/payment/accept
Accept orchestration payment
acceptOrchestrationPayment body → 201
POST
/v4/orchestration/payment/reversal
Reverse orchestration payment
reverseOrchestrationPayment body → 201
GET
/v4/orchestration/payment/notification
Get orchestration notifications by status
getOrchestrationPaymentNotifications 6 params → 200
GET
/v4/orchestration/payment/notification/urn/{uniqueReferenceNumber}
Get orchestration notifications by unique reference number
getOrchestrationPaymentNotificationsByUniqueReferenceNumber 1 param → 200
GET
/v4/orchestration/payment/notification/{uuid}
Get orchestration notification
getOrchestrationPaymentNotificationByUUID 1 param → 200
PUT
/v4/orchestration/payment/notification/{uuid}/ack
Acknowledge orchestration notification
acknowledgeOrchestrationPaymentNotificationByUUID 1 param → 200
PUT
/v4/orchestration/payment/notification/ack
Acknowledge orchestration notifications
acknowledgeOrchestrationPaymentNotifications body → 200
POST
/v4/orchestration/payment/action
Post action to orchestration payment
sendOrchestrationPaymentAction body → 201

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are OrchestrationPaymentRequest (21 properties), OrchestrationPaymentResponse (18 properties), OrchestrationPaymentReturnRequest (8 properties), Page (8 properties). Each schema is shown below with its type and property counts.

ActivityError
object
Activity error object in JSON format.
3 properties
OrchestrationPayments
PaymentCustomRateRequest
object
Custom rate that the return payment quotes must use.
4 properties 4 required
ActivityStatus
string
Activity status
OrchestrationPaymentRequest
object
JSON request object that represents an orchestration payment.
21 properties 7 required
Page
object
Paginated response base object.
8 properties
OrchestrationPaymentAcceptRequest
object
JSON request object that represents an orchestration payment accept request.
5 properties 3 required
NotificationResponseRos
object
JSON request object that represents an orchestration payment notification.
7 properties
PaymentActionRequest
object
5 properties 3 required
OrchestrationPaymentReturnRequest
object
Use this JSON request object to return a payment.
8 properties 2 required
OrchestrationPaymentSubmitResponse
object
JSON response object that represents an orchestration payment query ID.
1 property
NotificationAckResponse
object
Orchestration payment notification acknoledge response.
2 properties
NotificationList
array
List response of external notifications.
PaymentReversalReasonRos
object
A structured object detailing reasons for a payment reversal.
2 properties 1 required
NotificationUUIDList
object
JSON request object that represents a list of orchestration payment notification UUIDs to acknolwedge.
1 property
PaymentActionResponse
object
JSON response object that represents a payment action query ID.
1 property
Sort
object
6 properties
OrchestrationPaymentReversalRequest
object
Use this JSON request object to reverse a payment.
3 properties 3 required
ActivityOutput
object
Use this object when notificationtype is PARTNERSUBSTATE. For all other values of notificationtype, this property can be null.
3 properties
OrchestrationPaymentResponse
object
JSON response object that represents an orchestration payment.
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-orchestration-payments-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
#Orchestration payments
← Back to R APIs
API Details
ID
ripple-labs:ripple-labs-orchestration-payments-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
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ripple-labs-orchestration-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ripple-labs-orchestration-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 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.