SDP-1928: Update SDP API reference #2150

philipliu · 2025-12-19T21:06:43Z

This updates SDP's API reference to match the code in the main branch. Most of the change was generated by pointing Codex at both the backend codebase and API references and diffing them. I mostly just manually verified the changes and made some tweaks for wording.

stellar-jenkins · 2025-12-19T21:16:31Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T16:46:18Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T21:18:13Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

Copilot

Pull request overview

This PR updates the Stellar Disbursement Platform's API reference documentation to match the current implementation in the main branch. The changes include new endpoints for enhanced receiver wallet and payment management, standardized SEP-10 and SEP-24 endpoint paths, updated default sorting behavior, and improved API documentation consistency.

Key Changes:

Added new receiver wallet management endpoints (/receivers/{receiver_id}/wallets/{receiver_wallet_id}, /receivers/wallets/{receiver_wallet_id}/status)
Added payment management endpoints (/payments/retry, /payments/{id}/status)
Renamed SEP-24 registration endpoints from /wallet-registration/* to /sep24-interactive-deposit/*
Renamed authentication endpoint from /WEB_AUTH_ENDPOINT to /sep10/auth
Changed default sort direction from asc to desc and default sort field from created_at to updated_at across multiple list endpoints
Standardized content types from */* to application/json in responses
Removed redundant example data from error response schemas
Added new security schemes for SEP-10 and SEP-24 authentication

Reviewed changes

Copilot reviewed 78 out of 78 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
openapi/stellar-disbursement-platform/main.yaml	Main OpenAPI specification with all endpoint and schema updates
openapi/stellar-disbursement-platform/bundled.yaml	Bundled version of the OpenAPI spec with identical changes to main.yaml
docs/.../verify-receiver-registration.api.mdx	Updated endpoint path and removed Authorization header parameter
docs/.../upload-disbursement-instructions.api.mdx	Updated example data in error responses
docs/.../update-wallet.api.mdx	Changed response schema and added missing error responses
docs/.../update-user-*.api.mdx	Removed password field from profile update, standardized responses
docs/.../update-receiver.api.mdx	Added new wallet fields to response schema
docs/.../update-receiver-wallet*.api.mdx	New documentation files for receiver wallet management endpoints
docs/.../update-payment-status.api.mdx	New documentation for payment status update endpoint
docs/.../sidebar.ts	Added new endpoint entries to the API reference sidebar

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions · 2026-01-06T21:31:56Z

Warning

This change removes routes. The diff of routes is below. Please verify that these changes to the routes are intentional and that redirects are in place if needed. Redirects can be added to nginx/includes/redirects.conf.

diff --git a/routes.txt b/routes.txt
index 1e45f02b..15b1fe9f 100644
--- a/routes.txt
+++ b/routes.txt
@@ -635,6 +635,7 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-api-key
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-asset
+/docs/platforms/stellar-disbursement-platform/api-reference/delete-wallet
 /docs/platforms/stellar-disbursement-platform/api-reference/disbursements
 /docs/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions
 /docs/platforms/stellar-disbursement-platform/api-reference/export-disbursements
@@ -652,11 +653,16 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/get-organization-info
 /docs/platforms/stellar-disbursement-platform/api-reference/get-organization-logo
 /docs/platforms/stellar-disbursement-platform/api-reference/get-profile
+/docs/platforms/stellar-disbursement-platform/api-reference/get-receiver-registration-info
+/docs/platforms/stellar-disbursement-platform/api-reference/get-sep-24-info
+/docs/platforms/stellar-disbursement-platform/api-reference/get-sep-24-transaction
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-disbursements
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-payments
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-receivers
 /docs/platforms/stellar-disbursement-platform/api-reference/list-api-keys
+/docs/platforms/stellar-disbursement-platform/api-reference/list-receiver-verification-types
+/docs/platforms/stellar-disbursement-platform/api-reference/list-registration-contact-types
 /docs/platforms/stellar-disbursement-platform/api-reference/log-in
 /docs/platforms/stellar-disbursement-platform/api-reference/organization
 /docs/platforms/stellar-disbursement-platform/api-reference/patch-organization-circle
@@ -669,6 +675,7 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/request-challenge-transaction
 /docs/platforms/stellar-disbursement-platform/api-reference/request-registration-url
 /docs/platforms/stellar-disbursement-platform/api-reference/reset-password
+/docs/platforms/stellar-disbursement-platform/api-reference/reset-user-password
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-disbursement
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-payment
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-receiver
@@ -676,16 +683,21 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-all-statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-disbursement-statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-stellar-info-file
+/docs/platforms/stellar-disbursement-platform/api-reference/retry-payments
+/docs/platforms/stellar-disbursement-platform/api-reference/retry-receiver-invitation
 /docs/platforms/stellar-disbursement-platform/api-reference/send-one-time-passcode
 /docs/platforms/stellar-disbursement-platform/api-reference/soft-delete-a-tenant
-/docs/platforms/stellar-disbursement-platform/api-reference/start-wallet-registration
 /docs/platforms/stellar-disbursement-platform/api-reference/statistics
+/docs/platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api
 /docs/platforms/stellar-disbursement-platform/api-reference/update-a-disbursement-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-a-tenant
 /docs/platforms/stellar-disbursement-platform/api-reference/update-api-key
 /docs/platforms/stellar-disbursement-platform/api-reference/update-bridge-integration
 /docs/platforms/stellar-disbursement-platform/api-reference/update-organization-profile
+/docs/platforms/stellar-disbursement-platform/api-reference/update-payment-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-receiver
+/docs/platforms/stellar-disbursement-platform/api-reference/update-receiver-wallet
+/docs/platforms/stellar-disbursement-platform/api-reference/update-receiver-wallet-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-activation-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-profile
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-role

stellar-jenkins · 2026-01-06T21:32:29Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T21:41:47Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

github-actions · 2026-01-06T21:54:43Z

Warning

This change removes routes. The diff of routes is below. Please verify that these changes to the routes are intentional and that redirects are in place if needed. Redirects can be added to nginx/includes/redirects.conf.

diff --git a/routes.txt b/routes.txt
index 1e45f02b..15b1fe9f 100644
--- a/routes.txt
+++ b/routes.txt
@@ -635,6 +635,7 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-api-key
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-asset
+/docs/platforms/stellar-disbursement-platform/api-reference/delete-wallet
 /docs/platforms/stellar-disbursement-platform/api-reference/disbursements
 /docs/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions
 /docs/platforms/stellar-disbursement-platform/api-reference/export-disbursements
@@ -652,11 +653,16 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/get-organization-info
 /docs/platforms/stellar-disbursement-platform/api-reference/get-organization-logo
 /docs/platforms/stellar-disbursement-platform/api-reference/get-profile
+/docs/platforms/stellar-disbursement-platform/api-reference/get-receiver-registration-info
+/docs/platforms/stellar-disbursement-platform/api-reference/get-sep-24-info
+/docs/platforms/stellar-disbursement-platform/api-reference/get-sep-24-transaction
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-disbursements
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-payments
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-receivers
 /docs/platforms/stellar-disbursement-platform/api-reference/list-api-keys
+/docs/platforms/stellar-disbursement-platform/api-reference/list-receiver-verification-types
+/docs/platforms/stellar-disbursement-platform/api-reference/list-registration-contact-types
 /docs/platforms/stellar-disbursement-platform/api-reference/log-in
 /docs/platforms/stellar-disbursement-platform/api-reference/organization
 /docs/platforms/stellar-disbursement-platform/api-reference/patch-organization-circle
@@ -669,6 +675,7 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/request-challenge-transaction
 /docs/platforms/stellar-disbursement-platform/api-reference/request-registration-url
 /docs/platforms/stellar-disbursement-platform/api-reference/reset-password
+/docs/platforms/stellar-disbursement-platform/api-reference/reset-user-password
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-disbursement
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-payment
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-receiver
@@ -676,16 +683,21 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-all-statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-disbursement-statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-stellar-info-file
+/docs/platforms/stellar-disbursement-platform/api-reference/retry-payments
+/docs/platforms/stellar-disbursement-platform/api-reference/retry-receiver-invitation
 /docs/platforms/stellar-disbursement-platform/api-reference/send-one-time-passcode
 /docs/platforms/stellar-disbursement-platform/api-reference/soft-delete-a-tenant
-/docs/platforms/stellar-disbursement-platform/api-reference/start-wallet-registration
 /docs/platforms/stellar-disbursement-platform/api-reference/statistics
+/docs/platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api
 /docs/platforms/stellar-disbursement-platform/api-reference/update-a-disbursement-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-a-tenant
 /docs/platforms/stellar-disbursement-platform/api-reference/update-api-key
 /docs/platforms/stellar-disbursement-platform/api-reference/update-bridge-integration
 /docs/platforms/stellar-disbursement-platform/api-reference/update-organization-profile
+/docs/platforms/stellar-disbursement-platform/api-reference/update-payment-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-receiver
+/docs/platforms/stellar-disbursement-platform/api-reference/update-receiver-wallet
+/docs/platforms/stellar-disbursement-platform/api-reference/update-receiver-wallet-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-activation-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-profile
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-role

github-actions · 2026-01-06T21:59:14Z

Warning

This change removes routes. The diff of routes is below. Please verify that these changes to the routes are intentional and that redirects are in place if needed. Redirects can be added to nginx/includes/redirects.conf.

diff --git a/routes.txt b/routes.txt
index 1e45f02b..cc36aafe 100644
--- a/routes.txt
+++ b/routes.txt
@@ -635,6 +635,7 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-api-key
 /docs/platforms/stellar-disbursement-platform/api-reference/delete-asset
+/docs/platforms/stellar-disbursement-platform/api-reference/delete-wallet
 /docs/platforms/stellar-disbursement-platform/api-reference/disbursements
 /docs/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions
 /docs/platforms/stellar-disbursement-platform/api-reference/export-disbursements
@@ -652,11 +653,17 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/get-organization-info
 /docs/platforms/stellar-disbursement-platform/api-reference/get-organization-logo
 /docs/platforms/stellar-disbursement-platform/api-reference/get-profile
+/docs/platforms/stellar-disbursement-platform/api-reference/get-receiver-registration-info
+/docs/platforms/stellar-disbursement-platform/api-reference/get-sep-24-info
+/docs/platforms/stellar-disbursement-platform/api-reference/get-sep-24-transaction
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-disbursements
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-payments
 /docs/platforms/stellar-disbursement-platform/api-reference/list-all-receivers
 /docs/platforms/stellar-disbursement-platform/api-reference/list-api-keys
+/docs/platforms/stellar-disbursement-platform/api-reference/list-receiver-verification-types
+/docs/platforms/stellar-disbursement-platform/api-reference/list-registration-contact-types
+/docs/platforms/stellar-disbursement-platform/api-reference/load-wallet-registration-webview
 /docs/platforms/stellar-disbursement-platform/api-reference/log-in
 /docs/platforms/stellar-disbursement-platform/api-reference/organization
 /docs/platforms/stellar-disbursement-platform/api-reference/patch-organization-circle
@@ -669,6 +676,7 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/request-challenge-transaction
 /docs/platforms/stellar-disbursement-platform/api-reference/request-registration-url
 /docs/platforms/stellar-disbursement-platform/api-reference/reset-password
+/docs/platforms/stellar-disbursement-platform/api-reference/reset-user-password
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-disbursement
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-payment
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-a-receiver
@@ -676,16 +684,20 @@
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-all-statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-disbursement-statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/retrieve-stellar-info-file
+/docs/platforms/stellar-disbursement-platform/api-reference/retry-payments
+/docs/platforms/stellar-disbursement-platform/api-reference/retry-receiver-invitation
 /docs/platforms/stellar-disbursement-platform/api-reference/send-one-time-passcode
 /docs/platforms/stellar-disbursement-platform/api-reference/soft-delete-a-tenant
-/docs/platforms/stellar-disbursement-platform/api-reference/start-wallet-registration
 /docs/platforms/stellar-disbursement-platform/api-reference/statistics
 /docs/platforms/stellar-disbursement-platform/api-reference/update-a-disbursement-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-a-tenant
 /docs/platforms/stellar-disbursement-platform/api-reference/update-api-key
 /docs/platforms/stellar-disbursement-platform/api-reference/update-bridge-integration
 /docs/platforms/stellar-disbursement-platform/api-reference/update-organization-profile
+/docs/platforms/stellar-disbursement-platform/api-reference/update-payment-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-receiver
+/docs/platforms/stellar-disbursement-platform/api-reference/update-receiver-wallet
+/docs/platforms/stellar-disbursement-platform/api-reference/update-receiver-wallet-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-activation-status
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-profile
 /docs/platforms/stellar-disbursement-platform/api-reference/update-user-role

stellar-jenkins · 2026-01-06T22:04:18Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T22:09:37Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T22:22:06Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T22:24:10Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T22:37:32Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

stellar-jenkins · 2026-01-06T22:53:27Z

Preview is available here:
http://developers-pr2150.previews.kube001.services.stellar-ops.com

philipliu force-pushed the philip/sdp-api-reference branch from ae76be4 to a478427 Compare January 6, 2026 16:35

philipliu force-pushed the philip/sdp-api-reference branch from a478427 to dc3dccd Compare January 6, 2026 21:09

philipliu force-pushed the philip/sdp-api-reference branch from dc3dccd to e8582f4 Compare January 6, 2026 21:23

philipliu marked this pull request as ready for review January 6, 2026 21:24

Copilot AI review requested due to automatic review settings January 6, 2026 21:24

philipliu changed the title ~~Update SDP API reference~~ SDP-1928: Update SDP API reference Jan 6, 2026

Copilot started reviewing on behalf of philipliu January 6, 2026 21:25 View session

Copilot AI reviewed Jan 6, 2026

View reviewed changes

philipliu force-pushed the philip/sdp-api-reference branch from e8582f4 to 84fe6bf Compare January 6, 2026 21:31

Update SDP API reference

6b26524

philipliu force-pushed the philip/sdp-api-reference branch from 84fe6bf to 6b26524 Compare January 6, 2026 21:54

Update routes.txt

a0cd034

philipliu force-pushed the philip/sdp-api-reference branch from 5a6b7cd to a0cd034 Compare January 6, 2026 22:11

philipliu force-pushed the philip/sdp-api-reference branch from a324db0 to 6423567 Compare January 6, 2026 22:27

Add back generated route

f22d97b

philipliu force-pushed the philip/sdp-api-reference branch from 6423567 to f22d97b Compare January 6, 2026 22:44

SDP-1928: Update SDP API reference #2150

Are you sure you want to change the base?

SDP-1928: Update SDP API reference #2150

Conversation

philipliu commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stellar-jenkins commented Dec 19, 2025

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

stellar-jenkins commented Jan 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

philipliu commented Dec 19, 2025 •

edited

Loading