From 73690845230b7e6e78a203aac2c8dcfb15d5db93 Mon Sep 17 00:00:00 2001 From: tomerweller Date: Thu, 16 Jan 2025 00:11:51 -0500 Subject: [PATCH 1/5] better trustline description (#1181) remove the language about the relationship between trustlines and trading. In flight, as a hop in a path payment, an account can trade an asset that it does not have a trustline for --- docs/learn/fundamentals/stellar-data-structures/accounts.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/learn/fundamentals/stellar-data-structures/accounts.mdx b/docs/learn/fundamentals/stellar-data-structures/accounts.mdx index 68659ae9c..425c60fb2 100644 --- a/docs/learn/fundamentals/stellar-data-structures/accounts.mdx +++ b/docs/learn/fundamentals/stellar-data-structures/accounts.mdx @@ -40,7 +40,7 @@ Account data is stored in subentries, each of which increases an account’s min ## Trustlines -Trustlines are an explicit opt-in for an account to hold and trade a particular asset. To hold a specific asset, an account must establish a trustline with the issuing account using the change_trust operation. Trustlines track the balance of an asset and can also limit the amount of an asset that an account can hold. +Trustlines are an explicit opt-in for an account to hold a particular asset. To hold a specific asset, an account must establish a trustline with the issuing account using the change_trust operation. Trustlines track the balance of an asset and can also limit the amount of an asset that an account can hold. A trustline must be established for an account to receive any asset except lumens (XLM). You can create a claimable balance to send assets to an account without a trustline, but the recipient has to create a trustline to claim that balance. Learn more here: [Claimable Balances Encyclopedia Entry](../../encyclopedia/transactions-specialized/claimable-balances.mdx) From 1205541d3cd41cd41644d456c94a3fd2ea4cd024 Mon Sep 17 00:00:00 2001 From: "john.xlm" <60260750+JFWooten4@users.noreply.github.com> Date: Thu, 16 Jan 2025 20:05:40 -0500 Subject: [PATCH 2/5] Add initial community endpoint (#1145) --- docs/data/horizon/horizon-providers.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/data/horizon/horizon-providers.mdx b/docs/data/horizon/horizon-providers.mdx index c07f78f1e..de4ade67b 100644 --- a/docs/data/horizon/horizon-providers.mdx +++ b/docs/data/horizon/horizon-providers.mdx @@ -27,7 +27,13 @@ These providers allow access to the Testnet and Mainnet networks. †_Please note that Blockdaemon and Validation Cloud provide full historical data for Horizon._ -## SDF Provided Horizon (Futurenet and Testnet) {#sdf-provided-horizon} +## Publicly Accessible Horizon URLs + +| Provider | Mainnet Endpoint | Testnet Endpoint | +| -------- | ---------------- | ---------------- | +| [LOBSTR](https://lobstr.co) | `https://horizon.stellar.lobstr.co` | N/A | + +## SDF Provided Horizon (Futurenet and Testnet only) {#sdf-provided-horizon} SDF provides a Horizon endpoint but it is rate-limited and subject to changes such as truncation of history. Developers are encouraged to select an ecosystem provider. In some cases, projects may choose to run their own Horizon instance. From 077d9420819459ae6c26b874a1ecb198ef50253c Mon Sep 17 00:00:00 2001 From: Marwen Abid Date: Fri, 17 Jan 2025 12:50:06 -0800 Subject: [PATCH 3/5] [SDP-1462] Add API docs for Exports and Delete Disbursements (#1186) * SDP-1462 Add API docs for Exports and Delete Disbursements * SDP-1462 Address PR comments --- .../api-reference/list-all-payments.api.mdx | 26 +- .../bundled.yaml | 442 ++++--- .../stellar-disbursement-platform/main.yaml | 443 ++++--- .../api-reference/callbacks/get-rates.api.mdx | 2 +- .../callbacks/post-event.api.mdx | 2 +- .../callbacks/put-customer.api.mdx | 2 +- .../delete-a-disbursement.api.mdx | 1148 +++++++++++++++++ ...download-disbursement-instructions.api.mdx | 103 +- .../export-disbursements.api.mdx | 484 +++++++ .../api-reference/export-payments-csv.api.mdx | 484 +++++++ .../export-receivers-csv.api.mdx | 484 +++++++ .../list-all-disbursement-receivers.api.mdx | 164 ++- .../api-reference/list-all-payments.api.mdx | 10 +- .../api-reference/retrieve-a-payment.api.mdx | 10 +- .../api-reference/sidebar.ts | 30 + 15 files changed, 3415 insertions(+), 419 deletions(-) create mode 100644 platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement.api.mdx create mode 100644 platforms/stellar-disbursement-platform/api-reference/export-disbursements.api.mdx create mode 100644 platforms/stellar-disbursement-platform/api-reference/export-payments-csv.api.mdx create mode 100644 platforms/stellar-disbursement-platform/api-reference/export-receivers-csv.api.mdx diff --git a/docs/data/horizon/api-reference/list-all-payments.api.mdx b/docs/data/horizon/api-reference/list-all-payments.api.mdx index 4d5281775..ffa8c0da4 100644 --- a/docs/data/horizon/api-reference/list-all-payments.api.mdx +++ b/docs/data/horizon/api-reference/list-all-payments.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful payment-related operations and sidebar_label: "List All Payments" hide_title: true hide_table_of_contents: true -api: eJztXOly27iWfhUUf3QnXdo3S6rquuM4Tizbid22kkySdqkh4FBCmwR4AdCKr0tV8xrzevMkUwckJUqmE29Zulv+Y5vEcvZzAALflWfpxHj9j94xvQxBWuOdlTwOhmkRWaGk1/eGU2EISB4pIS0JhLGG0CAgpzFjYIwfByRKOpc1BNQCJyoCTbG7IVRywqgkYyCxAU6EJMZqoKGQExIqDhVyuvI/jq1mhlyqmFjl5gNJfKWJhFk2kyHUEDuFS0I1EMo5cGxsp0BOLQQB1SQAPgFdIQOfMBoERVOXyJ7S4j9KkpkIAmIs1ZZQ64YBqgMBxpJzqWYym5fEMgBjCCUs1kZpIgwxYEs49mwq2JQwaoAImx/R1yokdkpt2qlCnl1iL4t04FzpWBc0iAHZkGpWcvyj4BKSl4wzDU7GRkgG2EoTDf+OkVQrQqiQo6Xwk0kT6WuwsZbAyfiS2BWVCsmCmEM/HXpEGVOxtKVsTvzDTkfpfyNjtWB2pIEJuIDilwYkLzndp4ONQtATIBWv5C2MY8C9vncojN0OgoX5lbyIahqCBY12eeVJGoLX9xIZeSVPoE3+OwZ96ZU85Fxo4F7fp4GBddPdJjIOx6ATQThuDQqYEhMBE75gJFDMEYMapISpIADm/lc+0WAiJQ0kViwMiWJnSKlCgUR0IuRkZNU5yFR9yieUaGBKc2TWsCmE1OtfefYyQj6EtDABZAQ+0TAKwOt3OrVOp77V2ur22r16rT2flxZsK83h7lxzMGIiacYHkuoGWpppQqEhZqrigBMaRUA12k5iOKlJkD+oYX+QJ9QwkFzIyVOiNPkDp/uDPMFf6WPnZs6qqJ7EzlOEkf/3P/9rU/ewhINP4yCRvxu2UDxoP3KC0pFxiHGJGuYlDHpnecEEIhT2joIZToGE9JMI4zAzDKflRBSZg1QItnPjO9/RVE4g0XkdiW/UaqRMqCRxFIFOGzoDE4ZMqeZM8STaZNEFg1cE2lc6pOi0GqhR0nxGaJkCgV+TXb12W7uq1/ICS1U68qkIgN9RcqdgXXzVSYDKzCMZKx/uhUSvQVqvG5PrjZ7kpijkYqxUAFQu9Y99Sq79ivb/VELelwUqDWVpfFyygj6y8i4N52m0BcqmC1daYRefZIGi4s3PSt6nsomjSGlryot84/UdJ94ipCDTjVoNf63RmaRVr+QxJS1Ii01oFAUiCVTVPw22u8oJjwbBke+CZSpGNf4TGHpHpJFYK5L5RoGQ5yYn7hvaGQj8L7eaavCLPNeZuXUuKs+9ecmzEEauLihQ9HyeV9zHZNCzkmeFDSA3hoRP9gcjKdJw8UORNMdm2aNDp2p0GSXh724dOcf9wSgD3wdmbyHVb0qVwRgD/EcjK9LAgMOPRdZaI2f9qxa31HJOsjluzuYlT/AicrOZBHfs56rJ661XzXxkFquvIs5KnlGxZotavmjyiFoLGlPOy4/b5Q+1cu/sqt2e58iinGtMRTi161xQpmXFhre6eMj6jESuV1Jz5XvV5qW0Ix/RAirXmJ5SMy1s5BZaKLwxDbDEKmzkxxKL6YeK4nFEumZWgntrBnCjuq/pNtXOQuArIi0QYIG4FsJZspdzhB033PZCs1/MJBCOAdfkX3bktPjONaRaUyznhIXwFpFgk7U2WWuTtTZZ655ZK923KkxXSxYeI0VRY8COiilavMatA3yd7X7gHs4FJBGdCzuiQTSlMg5b1x/VG05lyTjCmPgRUh1uejxcCerhKTcsNofvm0VzGk1F5ZhdkHs2X12SHS9sbZPUNkltk9Q2Se2rJbXCzzWAqeR267LGN0h6pQdnuSxb3jDtPyUJunHy8r/jEuqvrySXZjM3u1lMHIwVyWexUSiKHTsb5fPV2kqrGzlcafU4jH7PeqegxElNb13410V9li+D7DQthU5dbDpZhKZNXbSpizZ10aYu+oZ1EZ5UuWVRVG9uqqJNVfTXUdItq6K0RUg/bQqir1cQXRfj50qi0yQqbeqhTT20qYc29dBXqodWzubesgjqPlYN9EhcCvngIuL7fkRY9HSc5Gw5/d7+KlXOJhdscsEmF2xywVfKBUJeqHMYTZWxIz+WiWi+7SGuxbTuXFCms+TcdMHibnlL5L5LPHdj41azZfL7QsPcx94VQY4W1Lo2mWIKl0g0KBZhsnJID2yN2BRvJTyA99X13BcF8EMeT7jJqte5ych1Vug74w2Fy7ksoLMxZedeyRvHWjoSi3c2btitWNmBuL11FCnTm3/PSiQXOAcuFOwpY18sAsHZHEWTurwzoPWLW3l/WtYiWbWRRHxvam1k+tXqNLkZU7ZgrARbMcmlvYrSk2p20+1fyZWvX39yN2x+bf7krjD9iheCchcCHjBws9nZ6nSb3fZWo9ZsFk+THfJ/wDT1Rrfb6tXavW57bQ53qwmVvnJgcnEk8uMDBbm8p1LN0VBQcN1hzPwVmWqz2e1Bz6/5ddpp+/XeVrPDKPPbrRZrQLfRbtab0G21tvx2p9doNsfjLh83e5R2alus2+321iqsB7NWzQZbq5HuMHA6wr+WCvrpuhrXi517j09vGD6tOLz8w/UCY+3lTcVFEonWywnv5fb2h0FruHPSHL5vH+3v7Qz3dxrbrd9O33d29t/t77UH2/vDlweD143dk63DZ6/fHhzt7Lx7veUtotraee9lpVBbrQa8Rq3eLtd65WZtWN/q19v9dutDUQTqew+2p6KD4F6jVqklP8tjzg8SQF6Kh8c7Ox9et97/93bz/av9vYPDzs7bwe7OwfHh/v7O8O2r09fv3z0bHuy/ax209347fH/4/NWH4TO3nHt83+78fX278418u/N1fbtT5Nudz/l253v4dnYqdunU9e/p1PladVlzJnXag7hVD/HhZeXn9bKfdq+Cv7ZqtUd18dVK5RG9vMHHrXGjwWit3q3Xe6xda2zRbq291e3Wm77P/Ha3wThtUdqDZp3xXmPcajK/Pua05bM2fRQvX+Xuqzr6dUE+tq+vz5C5+9rzax5/7f2dnf7eZnyvhF6vlWv1Ya2Fvl+r3+D7DzavOyX0+/txTorHjYO9d29eHe293xocNbfe7L/fOt19NhgM9wfPP5y2n58MBr+dHO++GbbevjnY+/Dby8HJu9MWLpDSH1wlWZAGTdvV8Odw6fWLL4WXsiUTKhWvjodgpwrNZQKLb4l9b7GkQHmAvsigMWId3M5cvSIkhGHSjrwGO1P63AWs4hH92MYabjPmi6wlkdmoZ7iz7SdL53SBmeIiIPugTdK7VqlV6m4HLgypvly2IpFWF4I7EA6yNxwek+3jAd7c59TS7AJ+BvqSzlohA4Q1mYDDqpGcaCg7wTnQmKRnpBWPWYaHcm2IBA8ENyQX2A5AjUAsEUWYkiYOIetKL0DTCZDcLX3ioHDEBWSwNDn8h7LSAiSiCjhCNEQaDEibYgo4mJzx5YKgHaUBMSmEcZzn+BhrwSdAxmBnABKnT7hd7XmsFe4AGRKIcyAzxMKxpkQ4MJBW00D8B/ENPqU7SilqC2ZckmzTOIoWWBZWEROPHeRFLpGUiENhQBWlzkRSfy0hYkiKYQMXDsHG0bGOw7DsWblmWf90S/iYV+jZk8w9OVxAgHnUrKSmlOwqUxrKUnF4+o+ynt/l7zKbLoU+oi57AicXghL25uSwRCgZazUzoN0MSkIG7rGQ9enzA/NFWXPFTNUqFZiq4ecGJa2IBjSnBNlJ4X7ZJ2EvcXwH1hQlAi2RGTjomTAEyR3aEwqKSpyYCGksUI6dQnqOOFFcaGDW6RDhrIzj06l1EgsOJPGYMRgyVTMnEh4KieBZmmQm7swxkw1O4dBonmjwE2N2/D9fcPozeRaoyVIGs9lslflFy/I4UJMqLUuYlU0sy5iFplBO88dTB4BjFLoJZecTrWLJiZLr3pDYjmZTYYHZWNOAiBB9HhLkK5Wi5YT0T0TLSlIHGcdh9LRCXiAYl0w+IOFjOlYxAuc4ElGA6XwL01AcxtRAibApsHOCrfP8OzielyjapQAmwk7jcYWpsJrKoTpR1XGgxtWQoqSr6F6CgclSZxVhebSkQWIpL98Mnu+OXhydjJ7vvt09PDrePTmthPypU+Yz8JUGNIsxTIRE4J+fDZkpbRGuSVhXL6eIYRgkhCMR2FQlaEOOenRa8lrx+4QJwhVzMEROgn3yyy8zIBzhyCyChSltgOhYSiQiEyMqNAlSFNHOJKcBOlM+hiws7ZdfkvAADnyLBsGlG9r1HV3QQHDH4Oha5gN0DA3EzhQxgN9SLLqWZKBlGnI4MBVHQSqfEIO0CLHcotI68xsrJ8ZA0LEI0B+xV874KiuOgb4XUkknYIhA05tJBDrTwMsc4eAy41P+KqsqsiJ0IRHnTHtiyMOAqHwicTVDnszg5yAgOb8TDtCOkt+9HRq5ZIHD/e4tZIcmgjU26NAc+aeJmeVKtZUVHjYqK7+cWmMKJUSZ2zBPEZQysvPm/gIdk6YfRVdLwdXCD0Iq3FsIAvVf+XfzkhcIBtJAbq7tiLIpkEYFC3bB0XZ94Yr25E05ebOcMQ021L11PKWDmurhYGf39ekudqlMbRi4FVakjA2pzE2JXyfIdhCQHLDcSlFxtYRX2iAcbhAOHxXhMF1QW/hkq1FAhfuQ7qz7Kl3SffSiHN4mfivGZ1dXmJHe6GA+x8cJsBku9LgwdBzcBG2WN+Xvj3hYyHyyBl5gOKarXs+tOe/C3F8G2PAzUsggHe8phL8RiOFnhJTBO95TSF8Jr/AzBF+DV1yl/IuEflVUws9SnmIpLuk9w3+0QFF7/Y/43X8K1G2yLXazthmDKK+fawCFK7tZL3eH3nz+/zT8dzA= +api: eJztXOty27iSfhUUf8wkU7rfLKlq6qzjOLFsJ/bYSrJJxqWBgKaEMQnwAKAVH5eq9jX29fZJthokJUqmE99ymRn5j20Sl+6vu9ENkviuPEsnxut/9I7pZQjSGu+s5HEwTIvICiW9vjecCkNA8kgJaUkgjDWEBgE5jRkDY/w4IFHSuawhoBY4URFoit0NoZITRiUZA4kNcCIkMVYDDYWckFBxqJDTlf9xbDUz5FLFxCo3H0jiK00kzLKZDKGG2ClcEqqBUM6BY2M7BXJqIQioJgHwCegKGfiE0SAomrpE9pQW/1GSzEQQEGOptoRaNwxQHQgwlpxLNZPZvCSWARhDKGGxNkoTYYgBW8KxZ1PBpoRRA0TY/Ii+ViGxU2rTThXy7BJ7WZQD50rHuqBBDKiGVLOS0x+BS0ReKs40OIyNkAywlSYa/h2jqFaEUCFHS/CTSRP0NdhYS+BkfEnsikmFZEHMoZ8OPaKMqVjaUjYn/mGno/S/kbFaMDvSwARcQPFNA5KXnO3TwUYh6AmQilfyFs4x4F7fOxTGbgfBwv1KXkQ1DcGCRr+88iQNwet7CUZeyRPok/+OQV96JQ81Fxq41/dpYGDddbeJjMMx6AQIp61BgCkxETDhC0YCxZwwaEFKmAoCYO5/5RMNJlLSQOLFwpAodo6UGhRIRCdCTkZWnYNMzad8QokGpjRHZQ2bQki9/pVnLyPUQ0gLE0BF4BMNowC8fqdT63TqW62tbq/dq9fa83lpobbSHO6uNQcjJpJmeqCobqClmyYSGmKmKg44oVEEVKPvJI6TugT5gxr2B3lCDQPJhZw8JUqTP3C6P8gT/JVedmHmvIrqSewiRRj5f//zvzYND0s4+DQOEvzdsIXwoP/ICaIj4xDXJWqYlyjoneWBCUQo7B2BGU6BhPSTCOMwcwxn5QSKLEAqBNu58V3saConkNi8jsI3ajVSJlSSOIpApw2dgwlDplRzpniy2mSrCy5eEWhf6ZBi0GqgRknzGdAyAwK/hl29dlu/qtfygKUmHflUBMDviNwpWLe+6mSBytwjGSu/3AuJUYOyXncm1xsjyU1RqMVYqQCoXNof+5Rc+xXr/6mEvK8KVBrK0vVxqQrGyMq9dDlPV1ugbLoIpRV18Uq2UFS8+VnJ+1Q2cRQpbU15kW+8vtPEWywpqHSjVsNfa3ImadUreUxJC9JiExpFgUgWquqfBttd5cCjQXDku8UyhVGN/wSG0RFpFNaKZL5RIOS5ycF9QzsDgf/lVlMNflHkOje3LkTluTcveRbCyNUFBYaez/OG+5gMelbyrLAB5MaQ8Mn+YCJFGi5+KJHm2Cy7dOhMjSGjJPzdvSMXuD+YZOD7wOwtUP2mUhlcY4D/aGJFGhhw+LHEWmvkvH/V45ZWziGb0+ZsXvIELxI3m0lwp36umrzeetXNR2ax+yrSrOQZFWu2qOWLJo+otaAx5bz8uF3+UCv3zq7a7XlOLMq5xlSEU7vOBWVaVmx4q5uHrM9I5HolNVe+V21eSjvyES2Qck3pKTXTwkZuo4XgjWmAJVZhIz+WWEw/FIrHgXTNrQT31hzgRnNfs21qnQXgK5AWAFgA1wKcpXq5QNhxw20vLPvFTALhGHBP/uVATovvXEOqNcVyTlgIb7ESbLLWJmttstYma90za6XPrQrT1VKFx0hR1Biwo2KJFrfx0QHezp5+4DOcC0hWdC7siAbRlMo4bF2/VG84kyXjCGPiR0h1+NDj4UZQD0+5YbE7fN8smrNoCpVTdiHu2Xx1S3a88LVNUtsktU1S2yS1r5bUCl/XAKaS2+3LGt8g6ZUenOWybHnDtP+UJOjGyeN/xy3UX99ILs1mYXYzTByMFclrsVEoigM7G+Xz1dpKqxs1XGn1OIp+z3qnoMRJXW8d/OtQn+XLIDtNS6FTtzadLJamTV20qYs2ddGmLvqGdRF+qXLLoqje3FRFm6ror2OkW1ZFaYuQftoURF+vILoO4+dKotNkVdrUQ5t6aFMPbeqhr1QPrXybe8siqPtYNdAjaSnkg4uI7/sSYdHTaZLz5fR9+6vUOJtcsMkFm1ywyQVfKRcIeaHOYTRVxo78WCbQfNuPuBbTFm/mlqdC7rulcyc0iuUr3tesOU/SP22d87QV0EYLSV3/zAiF2yEaFMOV7BLSj7NGbIonEB6g91/x04MvbbydR/nOEUPh8icL6GxM2blX8saxlk6k4qcUNzx5uMOHBiuv/tNf2Vv/nDoFZvTm33nPmgVZTs6Bi/09ZeyLReSfzRG/NMadF62f1MoH1LL4yMqLZIn3ptZGpl+tTpOjMGULxkqwFZOc0qsoPalmR9v+lZzx+vUnd6Tm1+ZP7szSr3gCKHcC4AEDN5udrU632W1vNWrNZvE02Vf9D5im3uh2W71au9dtr83hjjGh/Ve+kFx8A/nxgUAuD6ZUczIUVFh3GDN/JqbabHZ70PNrfp122n69t9XsMMr8dqvFGtBttJv1JnRbrS2/3ek1ms3xuMvHzR6lndoW63a7vbWS6sGqVbPB1oqiOwycjvCvpYF+um7G9erm3uPTG4ZPSwwvf3G9oli7eVM1kZwzWq8fvJfb2x8GreHOSXP4vn20v7cz3N9pbLd+O33f2dl/t7/XHmzvD18eDF43dk+2Dp+9fntwtLPz7vVWtsRc+8B7WRrUVtO/16jV2+Var9ysDetb/Xq73259KFqM+t6D/anoy2+vUavUkp/ld80PAiCP4uHxzs6H1633/73dfP9qf+/gsLPzdrC7c3B8uL+/M3z76vT1+3fPhgf771oH7b3fDt8fPn/1YfjM7d8eP7Y7f9/Y7nyj2O583djuFMV253Ox3fkesZ19BrsM6vr3DOp8wbosRJNi7kHaqofE8LI89HrZT7tXwV9btdqjhvhqpfKIUd7g49a40WC0Vu/W6z3WrjW2aLfW3up2603fZ36722CctijtQbPOeK8xbjWZXx9z2vJZmz5KlK9q91UD/TqQjx3r6zNk4b52/VrEX7t/56C/txvfK6HXa+VafVhrYezX6jfE/oPd604J/f5xnEPxuHGw9+7Nq6O991uDo+bWm/33W6e7zwaD4f7g+YfT9vOTweC3k+PdN8PW2zcHex9+ezk4eXfawg1S+oO7JAvSoGu7Gv4cLr1+8SnwUrZlQqPiWfEQ7FShu0xg8fKw7y22FIgH6IuMCyPWwe3c1SuiPhgm7chrsDOlz92CVTyiH9tYw23GfJG1JDIb9QwfZfvJ/jrdYKZECKg+aJP0rlVqlbp75BaGVF8uW5FIqwvBHesG2RsOj8n28QCP6nNqaXbiPmN5SWetkAHymEzAkdNITjSUHXCOJSbpGWnFY5YRoFwbIiEAwSeQCzIHoEYgeYgiTEkTh5B1pReg6QRI7lg+cdw34gIyHpoc4UNZaQESaQScIBoiDQakTUkEHC/O+HIh0I7SgCQUwjjNc3qMteATIGOwMwCJ0yfarvY81gofAxkSiHMgMyS/saZEODCQVtNA/AcJDT6lj5VSmhbMuCR5duMkWpBXWEVMPHYcF7lEUiKOdgFNlAYTSeO1hBQhKWkNXDjKGifHOvHCsmflmmf90z3hY96gZ0+y8ORwAQHmUbOSmlKxq0xpKEvF4ek/ynt+l7/LbLqU64i67AmcXAhK2JuTwxKhZKzVzIB2MygJGZvHAuvT5wfmi1hzxUzVKhWYquHnBpFWRAO6U0LlpPB52SdhL3F8x84UJYCWyAwc10wYguSO3gmBohInJkIaC5Rjp5CeIzEUFxqYdTZE/irj9HRmncSCA0kiZgyGTNXMQcJDIZEtS5PMxZ07ZtjgFI5+5okGP3Fmp//zhaY/k2eBmiwxmM1mq8ovWpbHgZpUaVnCrGxiWcYsNIVymj+eOsYbozBMKDufaBVLTpRcj4bEdzSbCgvMxpoGRIQY85BQXamUHiekfyI9VpI6yDgOo6cV8gLZt2Tyxggv07GKkSnHiYgApvMtXENxGFMDJcKmwM4Jts7r7/h3XiK0SwAmwk7jcYWpsJriUJ2o6jhQ42pIEekqhpdgYLLUWUUeHi1pkHjKyzeD57ujF0cno+e7b3cPj453T04rIX/qjPkMfKUB3WIMEyGR6ednQ2ZKW+RnEtbVyylFGC4SwokIbKoSeiEnPQYtea34fZYJwhVzvEMOwT755ZcZEI78YxbZwZQ2QHQsJQqRwYgGTRYpivRmktMAgym/hiw87ZdfkuUBHNsWDYJLN7TrO7qggeBOwdG1zAcYGBqInSliAF+oWAwtyUDLdMnhwFQcBSk+IS7SIsRyi0rr3G+sHIyBoGMRYDxir5zzVVYCA2MvpJJOwBCBrjeTyGymgZc58r9lzqf8VVVVZEXolkScM+2JSx4uiMonEncz5MkMfg4Ckos74RjsKPnd26GRSxY43O/eAjt0EayxQYfmyD9N3CxXqq3s8LBRWfnl1BtT7iDK3APzlDIpEzvv7i8wMGn6FnS1FFwt/CCkwt2FIFD/lb83L3mBYCAN5ObajiibAmlUsGAXHH3XF65oT+6UkzvLGdPFhrq7Tqd0UFM9HOzsvj7dxS6VqQ0Dt8OKlLEhlbkp8e0E2Q4CkmOSWykqrpZ8ShtKww2l4aNSGqYbagufbDUKqHBvzp13X6Vbuo9elCPYxBfGeO3qCjPSGx3M53g5YTLDjR4Xho6Dm7jM8q78/SkOC5VP9sAL0sZ01+u5PeddlPvLMBl+BoWMw/GeIPyNWAs/A1LG53hPkL4SQeFnBL7Gp7gq+RcF/ao0hJ+VPCVPXMp7hv9ogVB7/Y/43n8K1D1kWzzN2mYMorx9rjESrjzNerk79Obz/wc9V3AY sidebar_class_name: "get api-method" info_path: docs/data/horizon/api-reference/horizon custom_edit_url: null @@ -3000,10 +3000,10 @@ This endpoint lists all Successful payment-related operations and can be used in
  • @@ -3120,10 +3120,10 @@ This endpoint lists all Successful payment-related operations and can be used in
  • diff --git a/openapi/stellar-disbursement-platform/bundled.yaml b/openapi/stellar-disbursement-platform/bundled.yaml index fe4a5b1b7..4e08e0e8f 100644 --- a/openapi/stellar-disbursement-platform/bundled.yaml +++ b/openapi/stellar-disbursement-platform/bundled.yaml @@ -709,6 +709,42 @@ paths: message: Disbursement not found security: - BearerAuth: [] + delete: + tags: + - Disbursements + summary: Deletes a Draft Disbursement + description: Deletes a Disbursement in Draft or Ready Status by `id`. + operationId: DeleteADisbursement + parameters: + - name: id + in: path + description: ID of the `Disbursement`. + required: true + style: simple + explode: false + schema: + type: string + responses: + '200': + description: Deleted Disbursement details + content: + application/json: + schema: + $ref: '#/components/schemas/Disbursement' + '400': + description: Bad Request, Cannot delete a disbursement that has started + $ref: '#/components/responses/BadRequestResponse' + '401': + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + '403': + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + '404': + description: Not Found + $ref: '#/components/responses/NotFoundResponse' + security: + - BearerAuth: [] /disbursements/{id}/receivers: get: tags: @@ -750,69 +786,13 @@ paths: $ref: '#/components/schemas/DisbursementReceiverPagination' '401': description: Unauthorized - content: - application/json: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not authorized - extras: - status: 401 - message: Not authorized - example: - error: Not authorized - extras: - status: 401 - message: Not authorized + $ref: '#/components/responses/UnauthorizedResponse' '403': description: Forbidden - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: - error: Forbidden - example: - error: Forbidden + $ref: '#/components/responses/ForbiddenResponse' '404': description: Not Found - content: - application/json: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not found - extras: - status: 404 - message: Disbursement not found - example: - error: Not found - extras: - status: 404 - message: Disbursement not found + $ref: '#/components/responses/NotFoundResponse' security: - BearerAuth: [] /disbursements/{id}/instructions: @@ -851,100 +831,17 @@ paths: text/csv: example: '' '400': - description: Bad Request - content: - text/csv: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - foo: - type: string - message: - type: string - example: - error: Invalid request - extras: - foo: bar - message: Invalid request parameters - application/json: - example: - error: Invalid request - extras: - foo: bar - message: Invalid request parameters + description: Bad request, invalid request parameters + $ref: '#/components/responses/BadRequestResponse' '401': description: Unauthorized - content: - text/csv: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not authorized - extras: - status: 401 - message: Not authorized - application/json: - example: - error: Not authorized - extras: - status: 401 - message: Not authorized + $ref: '#/components/responses/UnauthorizedResponse' '403': description: Forbidden - content: - text/csv: - schema: - type: object - properties: - error: - type: string - example: - error: Forbidden - application/json: - example: - error: Forbidden + $ref: '#/components/responses/ForbiddenResponse' '404': - description: Not Found - content: - text/csv: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not found - extras: - status: 404 - message: Disbursement not found - application/json: - example: - error: Not found - extras: - status: 404 - message: Disbursement not found + description: Disbursement Not Found + $ref: '#/components/responses/NotFoundResponse' security: - BearerAuth: [] post: @@ -1200,6 +1097,254 @@ paths: message: Disbursement not found security: - BearerAuth: [] + /exports/disbursements: + get: + tags: + - Exports + summary: Export Disbursements + description: Exports a CSV file of disbursements. + operationId: exportDisbursements + parameters: + - name: q + in: query + description: A search term used to query through the disbursement names. + required: false + style: form + explode: true + schema: + type: string + - name: status + in: query + description: Exact match on the status of the disbursement. + required: false + style: form + explode: true + schema: + $ref: '#/components/schemas/DisbursementStatus' + example: DRAFT + - name: created_at_after + in: query + description: 'Only return disbursements that are created after this date. Format: YYYY-MM-DD' + required: false + style: form + explode: true + schema: + type: string + example: '2006-01-02' + - name: created_at_before + in: query + description: 'Only return disbursements that are created before this date. Format: YYYY-MM-DD' + required: false + style: form + explode: true + schema: + type: string + example: '2006-01-02' + - name: sort + in: query + description: Field used to sort disbursements + required: false + style: form + explode: true + schema: + type: string + default: created_at + enum: + - name + - created_at + - name: direction + in: query + description: Direction for sorting disbursements. + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc + responses: + '200': + description: CSV file of disbursements + content: + text/csv: + schema: + type: string + format: binary + '401': + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + '403': + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + security: + - BearerAuth: [] + /exports/payments: + get: + tags: + - Exports + summary: Export Payments + description: Exports a CSV file of payments. + operationId: exportPaymentsCSV + parameters: + - name: status + in: query + description: Exact match on the status of the payment. + required: false + style: form + explode: true + schema: + $ref: '#/components/schemas/PaymentStatus' + example: DRAFT + - name: receiver_id + in: query + description: UUID that represents a receiver in the database + required: false + style: form + explode: true + schema: + type: string + example: b6b667ad-6cc2-46cf-9be7-561daace7d48 + - name: created_at_after + in: query + description: 'Only return payments that are created after this date. Format: YYYY-MM-DD' + required: false + style: form + explode: true + schema: + type: string + example: '2006-01-02' + - name: created_at_before + in: query + description: 'Only return payments that are created before this date. Format: YYYY-MM-DD' + required: false + style: form + explode: true + schema: + type: string + example: '2006-01-02' + - name: sort + in: query + description: Field used to sort payments. + required: false + style: form + explode: true + schema: + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting payments. + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc + responses: + '200': + description: CSV file of payments + content: + text/csv: + schema: + type: string + format: binary + '401': + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + '403': + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + security: + - BearerAuth: [] + /exports/receivers: + get: + tags: + - Exports + summary: Export Receivers + description: Exports a CSV file of receivers. + operationId: exportReceiversCSV + parameters: + - name: q + in: query + description: A search term used to query through the receiver phone_number, email, and ID. + required: false + style: form + explode: true + schema: + type: string + - name: status + in: query + description: Exact match on the status of the receiver wallet. + required: false + style: form + explode: true + schema: + $ref: '#/components/schemas/ReceiversWalletStatus' + example: DRAFT + - name: created_at_after + in: query + description: 'Only return receivers that are created after this date. Format: YYYY-MM-DD' + required: false + style: form + explode: true + schema: + type: string + example: '2006-01-02' + - name: created_at_before + in: query + description: 'Only return receivers that are created before this date. Format: YYYY-MM-DD' + required: false + style: form + explode: true + schema: + type: string + example: '2006-01-02' + - name: sort + in: query + description: Field used to sort receivers + required: false + style: form + explode: true + schema: + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting receivers. + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc + responses: + '200': + description: CSV file of receivers + content: + text/csv: + schema: + type: string + format: binary + '401': + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + '403': + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + security: + - BearerAuth: [] /payments: get: tags: @@ -4069,6 +4214,7 @@ components: - PAUSED - SUCCESS - FAILED + - CANCELED PaymentStatusHistory: type: array description: An aggregated list of metadata objects containing the statuses and the timestamp of when these status changes occurred. diff --git a/openapi/stellar-disbursement-platform/main.yaml b/openapi/stellar-disbursement-platform/main.yaml index 59e30920a..7b4b65b78 100644 --- a/openapi/stellar-disbursement-platform/main.yaml +++ b/openapi/stellar-disbursement-platform/main.yaml @@ -713,6 +713,43 @@ paths: message: Disbursement not found security: - BearerAuth: [] + delete: + tags: + - Disbursements + summary: Deletes a Draft Disbursement + description: Deletes a Disbursement in Draft or Ready Status by `id`. + operationId: DeleteADisbursement + parameters: + - name: id + in: path + description: ID of the `Disbursement`. + required: true + style: simple + explode: false + schema: + type: string + responses: + "200": + description: Deleted Disbursement details + content: + application/json: + schema: + $ref: '#/components/schemas/Disbursement' + + "400": + description: "Bad Request, Cannot delete a disbursement that has started" + $ref: '#/components/responses/BadRequestResponse' + "401": + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + "403": + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + "404": + description: Not Found + $ref: '#/components/responses/NotFoundResponse' + security: + - BearerAuth: [] /disbursements/{id}/receivers: get: tags: @@ -755,69 +792,13 @@ paths: $ref: '#/components/schemas/DisbursementReceiverPagination' "401": description: Unauthorized - content: - application/json: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not authorized - extras: - status: 401 - message: Not authorized - example: - error: Not authorized - extras: - status: 401 - message: Not authorized + $ref: '#/components/responses/UnauthorizedResponse' "403": description: Forbidden - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: - error: Forbidden - example: - error: Forbidden + $ref: '#/components/responses/ForbiddenResponse' "404": description: Not Found - content: - application/json: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not found - extras: - status: 404 - message: Disbursement not found - example: - error: Not found - extras: - status: 404 - message: Disbursement not found + $ref: '#/components/responses/NotFoundResponse' security: - BearerAuth: [] /disbursements/{id}/instructions: @@ -858,100 +839,17 @@ paths: text/csv: example: "" "400": - description: Bad Request - content: - text/csv: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - foo: - type: string - message: - type: string - example: - error: Invalid request - extras: - foo: bar - message: Invalid request parameters - application/json: - example: - error: Invalid request - extras: - foo: bar - message: Invalid request parameters + description: "Bad request, invalid request parameters" + $ref: '#/components/responses/BadRequestResponse' "401": description: Unauthorized - content: - text/csv: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not authorized - extras: - status: 401 - message: Not authorized - application/json: - example: - error: Not authorized - extras: - status: 401 - message: Not authorized + $ref: '#/components/responses/UnauthorizedResponse' "403": description: Forbidden - content: - text/csv: - schema: - type: object - properties: - error: - type: string - example: - error: Forbidden - application/json: - example: - error: Forbidden + $ref: '#/components/responses/ForbiddenResponse' "404": - description: Not Found - content: - text/csv: - schema: - type: object - properties: - error: - type: string - extras: - type: object - properties: - status: - type: number - message: - type: string - example: - error: Not found - extras: - status: 404 - message: Disbursement not found - application/json: - example: - error: Not found - extras: - status: 404 - message: Disbursement not found + description: Disbursement Not Found + $ref: '#/components/responses/NotFoundResponse' security: - BearerAuth: [] post: @@ -1212,6 +1110,254 @@ paths: message: Disbursement not found security: - BearerAuth: [] + /exports/disbursements: + get: + tags: + - Exports + summary: Export Disbursements + description: Exports a CSV file of disbursements. + operationId: exportDisbursements + parameters: + - name: q + in: query + description: A search term used to query through the disbursement names. + required: false + style: form + explode: true + schema: + type: string + - name: status + in: query + description: Exact match on the status of the disbursement. + required: false + style: form + explode: true + schema: + $ref: '#/components/schemas/DisbursementStatus' + example: DRAFT + - name: created_at_after + in: query + description: "Only return disbursements that are created after this date. Format: YYYY-MM-DD" + required: false + style: form + explode: true + schema: + type: string + example: 2006-01-02 + - name: created_at_before + in: query + description: "Only return disbursements that are created before this date. Format: YYYY-MM-DD" + required: false + style: form + explode: true + schema: + type: string + example: 2006-01-02 + - name: sort + in: query + description: Field used to sort disbursements + required: false + style: form + explode: true + schema: + type: string + default: created_at + enum: + - name + - created_at + - name: direction + in: query + description: Direction for sorting disbursements. + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc + responses: + "200": + description: CSV file of disbursements + content: + text/csv: + schema: + type: string + format: binary + "401": + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + "403": + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + security: + - BearerAuth: [ ] + /exports/payments: + get: + tags: + - Exports + summary: Export Payments + description: Exports a CSV file of payments. + operationId: exportPaymentsCSV + parameters: + - name: status + in: query + description: Exact match on the status of the payment. + required: false + style: form + explode: true + schema: + $ref: '#/components/schemas/PaymentStatus' + example: DRAFT + - name: receiver_id + in: query + description: UUID that represents a receiver in the database + required: false + style: form + explode: true + schema: + type: string + example: b6b667ad-6cc2-46cf-9be7-561daace7d48 + - name: created_at_after + in: query + description: "Only return payments that are created after this date. Format: YYYY-MM-DD" + required: false + style: form + explode: true + schema: + type: string + example: 2006-01-02 + - name: created_at_before + in: query + description: "Only return payments that are created before this date. Format: YYYY-MM-DD" + required: false + style: form + explode: true + schema: + type: string + example: 2006-01-02 + - name: sort + in: query + description: Field used to sort payments. + required: false + style: form + explode: true + schema: + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting payments. + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc + responses: + "200": + description: CSV file of payments + content: + text/csv: + schema: + type: string + format: binary + "401": + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + "403": + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + security: + - BearerAuth: [ ] + /exports/receivers: + get: + tags: + - Exports + summary: Export Receivers + description: Exports a CSV file of receivers. + operationId: exportReceiversCSV + parameters: + - name: q + in: query + description: "A search term used to query through the receiver phone_number, email, and ID." + required: false + style: form + explode: true + schema: + type: string + - name: status + in: query + description: Exact match on the status of the receiver wallet. + required: false + style: form + explode: true + schema: + $ref: '#/components/schemas/ReceiversWalletStatus' + example: DRAFT + - name: created_at_after + in: query + description: "Only return receivers that are created after this date. Format: YYYY-MM-DD" + required: false + style: form + explode: true + schema: + type: string + example: 2006-01-02 + - name: created_at_before + in: query + description: "Only return receivers that are created before this date. Format: YYYY-MM-DD" + required: false + style: form + explode: true + schema: + type: string + example: 2006-01-02 + - name: sort + in: query + description: Field used to sort receivers + required: false + style: form + explode: true + schema: + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting receivers. + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc + responses: + "200": + description: CSV file of receivers + content: + text/csv: + schema: + type: string + format: binary + "401": + description: Unauthorized + $ref: '#/components/responses/UnauthorizedResponse' + "403": + description: Forbidden + $ref: '#/components/responses/ForbiddenResponse' + security: + - BearerAuth: [ ] /payments: get: tags: @@ -4106,6 +4252,7 @@ components: - PAUSED - SUCCESS - FAILED + - CANCELED PaymentStatusHistory: type: array description: An aggregated list of metadata objects containing the statuses diff --git a/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx b/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx index 3d0b42cf2..035f2439c 100644 --- a/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx @@ -417,7 +417,7 @@ The `~=` is defined as equality within rounding error. value={"Example (from schema)"} > diff --git a/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx b/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx index 522b6602b..74fca369d 100644 --- a/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx @@ -5,7 +5,7 @@ description: "Receive a JSON object representing an event." sidebar_label: "Receive an Event" hide_title: true hide_table_of_contents: true -api: eJydWFtT4zgW/isqvfSL40Bgemb91kOxVb21O81M2JcByijWcaxuW3JLMiGVyn+fOpJ8JYQAL8HSuenoXL6jHbVsbWhyR6+fQFpDHyL6PDNQu7Xl9c3sM43c7+Iy/HNxjkSqBs2sUPIrpwmtlbFOAI0oB5NpUeMeTehfkIF4AsLIf5bf/iBq9R0ySzTUGgxIK+SaMEkAeeN7SSOq4WcDxv6u+JYmO5opaVFusqOsrkuROaXz7wal76jJCqgY/me3NdCEegU0orVGE60Ag7uCD2iM1UKu6T4KC9ONiIJsKnSA1UwalqHKNNPALHAajVaNZbYxaVYwuXabPxtlYUCcNcaqCnTa1NwtPUxddFsAGYj0ziBoUkyumCQrIEoCUTmxBZBclaXaCLlO7uWMPB6w8JHMCBtJ3DBDwiaxhVbNunCyltc3BCSvlZDWxAQNqdm2VIwTYYiQjmio4pHkAkoev1A9dgNagKx+FS0f21OgPZ703VpH/vVHdUujQz4J1h7w4jfy5ebrq2ocb6/ABYWowFhW1YciI1e6YpYmFC9zhqTIEgS/HYeDU+GnkvAtp8ndSzZMA6GBYxQKjCMDNY3oDyHdh3MsjSirVCNtCs81ZD7eOBgrpMuSlGUZbnsGbYGnzGL8WWFL1HbbW7O8vllc0n30YUtO0XBxTvcP+5AjH05aA2WZ+oMf2TcGDm+vmu0xbrf9KjM810KDwVOeHhxaZAeqDEaasqxMX9934az0IU+NS8jSQlky/ZV/MoRpCGXWEFswSwTHQptvMdVnjQFtCJOc+FpOliA5VuEvMiuUNhFZNZZIZdt9X8AHFPG9vJf/VpowR3K+IG2Ji3xKCR7yiZhCNSXHAmaaPBeZcIVNkbwpy21vF3K1MtrEXDVGSDDmE/mdZT9A8onaF5YH5SHkH90RHyuoVDDGDKxpDEzlfSZKE9/nPi7wpAg+VP6dz0KB7zyhYS2MBT0o2t7hMcZGm9tvyr8WtgDty6EPExJ48cj/a56BdwuMcw3GtKYoOcsKJiTBi7Jbpxc9cNqhkJI8sbKB7qpdu+9PuBG2IIyYguneiIhsCtDgG8hoB+t2dx8x3e/7OtMlgEurQWN6pYaERvGOPB4o+9OVr33f2z9YygYir1pJ+z0uv6i5jrPvM8MmNai2HoK1IkytpPHqF2dn+PPyjjzWEIaYJsvAGJ+ZtVb4gZ6XnGhgfItpqwOWk/BsA2RzbbVVRVaKb1EYVHWIlss3FQv5xErBMRY1fHdd7JBUxIFMSOPCArRWmlRgDFuDDwR4tiCNUNK4dvoDtjRpkWxEXRQeRbT7BwxtW6gWzjpv24ImdA4B2RrQT6C9gkaXNKGFtbVJ5vOMleWKZT/itmzNPG0Mz6yqS2CuosSZqigqQvT6V49zrz1RGyd9HIZ4eQWF9jCFLs4Wl7Pzs9niX7fnvyaLi+R8EZ9/vvybjqHJGHyMdWFXT6jziWvtCeVQKyNs3+QTKmSm0FQLvXWdhCkWQcge+uyAyLfWQSoGNiHfyaAaeypHDpBysEyUHoRh2z3CgcUsEN/tqGTVgWO+XvpatR3QSSeO7oHS0YsL88KbdO2NvE3p7j8HnYZEPsEGAzoNkdfWpHS1Pc4U8nJ4Zg15I7np7yv1K++OkhzgVI6abSs30uIljq9A8LQLXtc3Btd6ckSdShoG2hO83frkDUIXWcHwdJDTh07qu/X4uz27hWdM7mErPGYdyCco1Tjlj/g4bLXKwifGv2p0Bt1sMs6jF6PLgcQ7xe17V9A/rAq7iZasTKdQ4nTPEsFxzi26e02nHIPlVxizEhFzylXFhByyho1paWrxiEs0A5J7aDI2/MBxx5a5mHUF4kPc47nlA9zddDhtUIOxb7o8LeDDIW+yOiUdjnSvxP8vrpH6MW3QnYfT2+ASPn74l9B1IvZ4mv7y9xSUDkU4VChk7tA74hjfri7is/jsIH5fbmVWaCVVY8hVADgGH1OIqSETeXiLI7kaTxd+fCI3JbMIpBFNIq5zA9dxuRxyRE8klExDKsaBrPyE2MnbFKIEIhx6DEjVzxWBjeRaVThmuCQhg2dDByzvpUdjn0wHMQ2iW1uAgV41y3N8qRxpntIfUuGmwA7Wd8dbOjxII1qKDKRx8R3S90vNsgLIwl1DjyuT+Xyz2cTM7cZKr+eB1cz/+/Xq+o/l9WwRn8WFrUqXNghaKyYHgru3V0kOPs4OXlff/047qFjzusT6tA/W7wJwvqMeOD9EtEBAndzR3W7FDPxfl/s9Lv9sQG9pcveACF0LtkKn3WF7K4C54tVB+Stv6ezWD0IB0L98Ex7h+Jtvy1tM+/CWXCmOPJptsPqyDU0oxZfs0Dx3fm1HSybXjUcwXib+/QNIuuTk +api: eJydWEtv4zgS/isEL33xK+5M70C3niAL9GJ3OjvOXjYJFFosWeyWSDWLimMY/u+DIilLchzHSS6OyHqxWI+vuOVOrJAnd/z6CbRD/jDiz2OE2q8trm/GX/jI/84v4z+fL4jI1GCFU0Z/kzzhtUHnBfARl4CZVTXt8YT/BRmoJ2CC/Wvx/U9mlj8gc8xCbQFBO6VXTGgGxDu513zELfxqAN0fRm54suWZ0Y7kJlsu6rpUmVc6/YEkfcsxK6AS9J/b1MATHhTwEa8tmegUIO0q2aNBZ5Ve8d0oLhxujDjopiIHOCs0ioxUppkF4UDy0WAVnXANplkh9Mpv/mqMgx5x1qAzFdi0qaVfejh00W0BrCcyOIORSRN2JTRbAjMamMmZK4DlpizNWulVcq/H7PGIhY9szMRA4logi5vMFdY0q8LLWlzfMNCyNko7nDAypBab0gjJFDKlPVFfxSPLFZRy8kL10A1kAbGGVbJ8aE9B9gTSd2sd+Dcc1S8NDvmkRHvAz7+zrzffXlXjeTsFPihUBehEVR+LjNzYSjiecLrMMZESSxT8dhz2TkWfRsP3nCd3L9koDZQFSVGoKI4Qaj7iP5X2H96xfMRFZRrtUniuIQvxJgGd0j5LUpFltB0YrAOZCkfx55QrSdttZ83i+mZ+yXejD1tyjobPF3z3sIs58uGkRSjLNBz8xD4iHN9eNptT3H77VWZ4rpUFpFOeHxxWZUeqDEWacaJMX9/34WzsMU8NS8jCQVkK+01+QiYsxDKLzBXCMSWp0OYbSvVxg2CRCS1ZqOVsAVpSFf6qs8JYHLFl45g2rt0PBbxHMbnX9/qfxjLhSS7mrC1xo5BSSsZ8YliYppRUwLDJc5UpX9gMy5uy3HR2EVcro03MZYNKA+In9ofIfoKWB2pfWB6Vx5B/9Ed8rKAy0RjsWdMgHMr7woxloc99XOBZEXys/HufxQK/94SFlUIHtle0g8MnFBttbr8p/1q5AmwohyFMWOSlI/+neQa5XxBSWkBsTTF6nBVCaUYX5TZeL3ngvEMRJXsSZQP7q/btvjvhWrmCCYaFsJ0RI7YuwEJoIIMdqtv7+5jw3a6rM/sE8GnVa0yv1JDYKN6Rxz1l//Xla9f19g+Wsp7Iq1bSbkfLL2qu5+z6TL9J9aptgGCtCKyNxqB+PpvRz8s7ClhDIcMmywAxZGZtDX2Q57VkFoTcUNraiOU0PLsI2XxbbVWxpZEbEgZVHaPl8k3FSj+JUkmKRQs/fBc7JpVwoFAafViAtcayChDFCkIgwLMDjcpo9O30J2x40iLZEfdReBLR7h4otF1hWjjrve0KnvApRGSLYJ/ABgWNLXnCC+dqTKbTTJTlUmQ/J23ZGgfaCTyLqi5B+IoyyUzFSRGh1786nHsdiNo46eIwxssrKLSDKXw+m/82nl2ML/5xO58ls9+Ty8vJl9++/J8PockQfAx1UVdPuPeJb+0Jl1AbVK5r8glXOjNkqoPOur2EQyxCkD322R5RaK29VIxsSr+TwTTuXI4cIJXghCoDCKO2e4KDilkkvttyLaojx3y99LVq90AnPXB0B5ROXlycF96ka2/kbUp//znYNCbyGTYg2DRGXluT0uXmNFPMy/6ZLeSNltjdVxpW3h0lOcC5HLXYVH6kpUscXoGS6T54fd/oXevZEXUuaRxoz/B265M3CH1kRcPTXk4fO2no1sPv9uwOnim5+63wlHWgn6A0w5Q/4eO41SqLnxT/prEZ7GeTYR69GF2OJN45bt/5gv5hVdRNrBZlegglzvcsU5Lm3GJ/r+khR2/5FcasJMScSlMJpfusceOwNLV4xCcagpYBmgwNP3LcoWU+Zn2B+BD3cG75APd+OjxsUL2x73D5sID3h7yD1UPS/kh3spGGMa3XnfvTW+8SPn74l9D1QOzbtWEISvsiPCpUOvfonXBMaFefJ7PJ7Ch+X2x0VlijTYPsKgIcpMcUhjVkKo9vcSw3w+kijE/sphSOgDShScJ1fuA6LVdCTuiJxZKJrBIS2DJMiHt560KVwJRHjxGphrkisrHcmorGDJ8krPds6IHlvQ5o7BPuISYSunUFIHSqRZ7TS+VA8yH9MRV+CtzD+v3xFh4P8hEvVQYafXzH9P1ai6wANvfX0OHKZDpdr9cT4Xcnxq6mkRWn//52df3n4no8n8wmhatKnzYEWiuhe4L3b6+aHX2c7b2uvv+dtlexpnVJ9WkXrd9G4HzHA3B+GPGCAHVyx7fbpUD4ny13O1r+1YDd8OTugRC6VWJJTruj9laA8MVrD+WvgqXj2zAIRUD/8k14gONvvi9uKe3jW3JlJPFYsabqK9Y84ZxesmPz3Ia1LS+FXjUBwQSZ9Pc3SgnlJA== sidebar_class_name: "post api-method" info_path: platforms/anchor-platform/api-reference/callbacks/callbacks-server custom_edit_url: null diff --git a/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx b/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx index b6c0708d1..bf54d4910 100644 --- a/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx @@ -5,7 +5,7 @@ description: "**The Anchor Platform does not persist any customer KYC data.**" sidebar_label: "Create or Update Customer Info" hide_title: true hide_table_of_contents: true -api: eJztGl1v47jxrxDsw90uZDnrCwrUb6nXe3Cvl83FSYtDHMiUNIp4K5E6kkpiBPnvxZCS9WHJ2fZaoAv4JZE5w/nizHCG5As17EHT+R1dlNrIHJSm9x59nmgo7PB6eTX5M/Xs/w+z6mN2Xn388AGxY9CR4oXhUtA5ff/+JgVyIaJUKnKVMZNIlZNYgiZCGlKA0lwbwsSORBVP8tOvCxIzw/z37zdiI5CAgt9LsHgxUaALKTSQRCpiUq4JiLiQXBjCFBAegzA8YhkxkpgUNuJue3V7Q6Y1/e3996kxhZ5Ppw/cpGXoRzKfagNZxlT9f1IoaWQks2mYyXCaM21ATSGSeqcN5FMNxeTs7MPMz+M/1YQnRWnebcSgrDEkXEBMuCDOeD6qtsg4oNhFkfGIock0ydmXvb6aPHGTohYkkVkmn7h42NsilPHOI08pj1LCNVrjiakY4kpvwqzR/cr4eiPyUhvyyDIeMwNWvNr8iI4WJwXTGmKvkt2USlhYreF3mmx5vPXJdS1fJIVhXKBcUmQ7oo3C74RDFqP0WbYRIYwJR1hLw23LDNPftBRbSx0NZHYFDDLdiJALpnZthuRr+eVlZnjBlJmiU07QAD2WG0E9KgtQVqhVTOe0KE0dHNSj1Vr8VcY7On+h1WT87CuDYzpKIWf4hdTpnMrwN4gM9WihkIvhoBHKY/zbDSSMgtVHIpPOgqBCbp2cbxkbK5XPyYQwUih45LLUBGOgEtenXi2BWy/66lEWRbJ0sh9yXruoIFKRn8tniMmFwyasNKmLNwNxY9t9pD9y5hz+bJBpDrkc5ogQdNayjuhkh47FGtUtM0Z0yhTEpBIfAwIUWCG6EIyRbfW9HRUmcKNDEiEEbWolK7XzrVq2NwU75OhREGWOaZXH1KMp0yniwLOh96818jFBWISDXX/gmoSAhvrp10WMYeBvxBqcPe5ucOK6gIgnlWv+t1MhijbRbQ7vSCyjMgdh2tnP5u5cYroWifQ34pNUxO0hZCdLEjFRpUz8qYh8ElZtXTs55imXCRL+ULr4bJGZnaPjT+qs6/xoq6GYnU/2+wAaC9fRhfmBOxjFhHY2DsYisoVDeOX/LiP30iaqifyY1jLiGCw++WcKwgJUbuUniZJ5dzljKEDEmrhl3og2v+/Bf/C9xoo1Fa5tnHN0PjRzxtQDZooc3VC/G1Y24UqbQLAcWumpAWfsGJTFMUfWLDuKo0DrwAaD2gWRjIcRtWEGAqmCQslHLqJhrIib3SCgkNqwbJx8JccgLJchzyAQZR6CGsSAnPEsOEYj5MqkAe6wh2CPulWic2oR9uhFxkb0dPA3jRYy8WXc9hZa5aFj2nXw6vwzwusNKkUqxVFLWqxQ4b581ODPBhQ6lvX8BFRQbxmHLpGx8CjLKCwDlnF2dPFzKWB3jEoHz/poPMZP7Qojj3pLhTK8DX6EQkHkcsWtBrIdNsaWcKENsHhwUzPsucpeI6Bxt5FRVBbMCTMYC0Umd6DGCewxjpkgY+KhZA8w7tw8HndGHr8dHDwOuNYlfH1U8jiA54K7beXfmnbEcXhx1A4angfHFSSgFMvGVrGTtIJHUPut9+0M9hY6Ogk3GQ5dNXVvVYdb8EANfap0T5XuqdL9lirdU/F3Kv5Oxd+p+DsVf/+z4q9IpZFo8ERJV3qMEnQnmp1JIYu+fOUcIQ1Tu4AV6J0sC2QS1GS+ksIbdaqjVigpk0CBxrJgKH0Nkh6rcds0ZRJwEckhrxo2Uj0r448gBqUenPf/V1f/XNfSTYH9agV1Va5VbHZ2dpgr1mUUgdaYAv7jE+j6yAirNNyFS3v1M1StD27a5aDZ67LvYrFYXt0sP1KPXl1/XizX69Xlj9Sjl8vlx3Wwuvz0mXr0evm35QKR7m1Jguf5Q4I29cZVR7i2AnZO9yrqQJnhrNLIvB+oXMajVXh7LuRRys4yDGX4VPKozY4ypRjS4gbyofjCzFs49VrQUMoMmKgcotp34uBkpEEj/RGP3DuhR/+xvF59Wi0ublafL4Pr5S+3q+vKOUEpOZTm7erkoDV7GNqMWlH/I7S6aRfe1fTzoQBfCXtt525F/0iUd1d3TA9vONJfu1nCzb5vlFragVqN80M1LqUhn2Qp4m9Bh6r+FBpvZen87oV+gR2d17fhHrWt1tfdir/eo1+YVFY3iKgFMymd0/2tNMXdUT3ilTvyKlVG57RuWSOWZVgD+GGpOe5xE4frwzPLC/R6e9UbyZwiK7ThdXMzuXRIdQZvgmF/ENIMuWK0+7sqwFzz3g+o/i1Ja89tdZXNaKuZbAnS7yE7oIHWsYEPdIwN0DWKze9Of3jAo6N3txtsJZBuE9jOgE3vR2dns/PJh7PJ7C+01+b1J4zp1WrqeoP9Xm4E3F+oTufWG+42bD1gr09rmWKkPWvZv9OVtcabZuzA5N0ebATctF4tor2O6wDSl67ujvojB2Zv90JtT+i0QAOAAVF6DU8D2Pc5naEx7+h1NV1/G2pgDjAODdyu+1vxhSV787NTNY+ES6/6HYmdESxM3CKxDTEmQwf7wT/zz2j/bZE9rt2JKFVS4LnvosqSmlxcrUjnbK56K9Qc7/ZfJBVK4vbi1w+Oxum6kzbdPNHJWQwk3HVPg59SngHh9iy2UBLLc3eoW7/esXe9jEQHL4B8coM3vS6lf6f3h9y6esqiW6+DWJJAZLqc+/hDLNwxYLXlNeqt7aaCXsojwJJk/kIr574oWJQCmdllaDan+XT69PTkMwv1pXqYVlP19O+rxfJyvZzM/DM/NXlm915MwDkTLcILBfgaSSpyW9h3SXVdRFboBgfl475sOD0tOz0t+9afllUZH29CpkXGuG1ebHS9VAXiHd0XiPceTaU2OPbyEjINtyp7fcXh30tQOzq/u8eiVHEWYlzfYaeSArO75L56XTgZJjeu+atq2MFrvFevnnQRRVCYFvpBwd4pcK9ub7B2qN7E5W7rQrqWrNd8ooyvr/8C/Ob/OQ== +api: eJztGmtv47jxrxDsh7tdyHI2l7aAv6Ve78G9XjbNo8UhDmRaGkW8lUgeSSUxgvz3YkjJelhytr0W6AL+ksic4bw4M5wh+UItezB0dkfnpbGyAG3ofUCfJwaUG75eXE7+RAP3/8Np9XF6Vn388AGxEzCx5spyKeiMvn9/kwE5F3EmNbnMmU2lLkgiwRAhLVGgDTeWMLElccWT/PTLnCTMsvD9+5VYCSSg4bcSHF5CNBglhQGSSk1sxg0BkSjJhSVMA+EJCMtjlhMric1gJe7Wl7c3ZFrTX99/n1mrzGw6feA2KzdhLIupsZDnTNf/J0pLK2OZTze53EwLZizoKcTSbI2FYmpATU5OPpyGRfKHmvBElfbdSgzKmkDKBSSEC+KNF6Jq85wDiq1UzmOGJjOkYF92+hryxG2GWpBU5rl84uJhZ4uNTLYBecp4nBFu0BpPTCeQVHoT5oweVsY3K1GUxpJHlvOEWXDi1eZHdLQ4UcwYSIJKdltq4WC1ht8ZsubJOiRXtXyxFJZxgXJJkW+JsRq/Uw55gtLn+UpsYEw4wloarltmmP5qpFg76mggu1UwyHQlNlwwvW0zJF/LryhzyxXTdopOOUED9FiuBA2oVKCdUMuEzqgqbR0cNKDVWvxFJls6e6HVZPzsK4NjJs6gYPiF1OmMys2vEFsaUKWRi+VgEMoT/NsNJIyC5Uci086CoEJ+nbxvWRcrlc/JlDCiNDxyWRqCMVCJG9KglsCvF30NKItjWXrZ9zlf+6ggUpOfy2dIyLnHJqy0mY83C0lj212kP3LmHf5kkGkBhRzmiBB01rKO6HSLjsUa1R0zRkzGNCSkEh8DAjQ4IboQjJF19b0eFSbyo0MSIQRt6iQrjfetWrY3BdvnGFAQZYFplSc0oBkzGeLAs6X3rzXyIUFYjINdf+CGbAAN9dMv8wTDIFyJa/D2uLvBidcKYp5WrvnfToUo2sS0ObwjiYzLAoRtZz+XuwuJ6VqkMlyJT1ITv4eQrSxJzESVMvGnJvJJOLVN7eSYp3wmSPlD6eOzReb0DB1/Umdd70drA+r0bLLbB9BYuI4+zPfcwWomjLdxNBaRLRzCK//3GbmXNlFN5MeMkTHHYAnJPzMQDqALJz9JtSy6y5mAApEY4pd5Jdr8vofwIQwaK9ZUuHFxztH50Mw50w+YKQp0Q/NuWNmUa2MjwQpopacGnLNDUJYkHFmz/CCOBmMiFwx6G8UyGUY0llmIpI6Ulo9cxMNYMbfbQYCSxrJ8nHwlxyCskBueQyTKYgN6EAMKxvPoEI0N1zaLcIfdBwfUrxKdUYewQ1c5G9HTw9802oaJL+O2d9AqDx3SroNX558RXm9QUZkUBy3psDYa9+WDBn+2oNGxnOenoKN6y9h3iZxtDrKMN2XEcs4OLn4hBWwPUengOR9NxvjprbLyoLdUKMPb4EdQGmKfK24NkPWwMdaEC2OBJYObmmXPVfYaAY27jYzjUjEvzGAsqFxuQY8T2GEcMkHOxEPJHmDcuXky7ow8eTs4eBJxY0r4+qjkSQTPivtt5d+adsBxuDpoBwPPg+MaUtCa5WOr2Ela0SPo3db7dgZ7Cx2dhNschy6bureqwx14oIY+VrrHSvdY6X5Lle6x+DsWf8fi71j8HYu//1nxpzJpJRo81dKXHqME/YlmZ9KGxV++co6QlultxBR6J8sjmUY1ma+k8Ead6qkpLWUaaTBYFgylr0HSYzVum6ZMIy5iOeRVw0aqZ+X8EcSg1IPz/v/q6p/rWropsF+doL7KdYqdnpzs54rrMo7BGEwB//EJdH1khFUa7sKlu/oZqtYHN+1y0Ox12Xc+ny8ubxYfaUAvrz7PF9fXy4sfaUAvFouP19Hy4tNnGtCrxV8Xc0S6dyUJnucPCdrUG5cd4doKuDndq6g9ZYazSiPzbqBymYBW4R34kEcpO8swlOEzyeM2O8q0ZkiLWyiG4gszr/LqtaAbKXNgonKIat9JoqORBo30ezxy54QB/cfiavlpOT+/WX6+iK4Wf79dXlXOCVrLoTTvVqcAY9jD0GbUivofodVN+/Cupp8NBfhSuGs7fyv6e6K8u7pjegTDkf7azRJ+9n2j1MIN1Gqc7atxIS35JEuRfAs6VPWnMHgrS2d3L/QLbOmsvg0PqGu1vu5W/PUe/cJmsrpBRC2YzeiM7m6lKe6O+hGv3JFXqXM6o3XLGrM8xxog3JSG4x438bghPLNCode7q95YFhRZoQ2vmpvJhUeqM3gTDLuDkGbIF6Pd31UB5pv3fkD1b0lae26rq2xGW81kS5B+D9kBDbSODXygY2yAvlFsfnf6wz0eHb273WArgXSbwHYGbHo/enpy+sfJyYfJhz/TXpvXnzCmV6up6w32e7kRcH+hOp1bb7jbsPWAvT6tZYqR9qxl/05X1hpvmrE9k3d7sBFw03q1iPY6rj1IX7q6O+qP7Jm93Qu1PaHTAg0ABkTpNTwNYNfndIbGvKPX1XT9baiB2cPYN3C77m/FF5bszc9O1TwSLr3qdyR2RrAwcYvUNcSYDD3sh/AkPKH9t0XuuHYr4kxLgee+8ypLGnJ+uSSds7nqrVBzvNt/kaS0xO0lrB8cjdP1J22meaJTsATIZts9DX7KeA6Eu7NYpSWW5/5Qt3694+56GYn3XgCF5AZven1K/87sDrlN9ZTFtF4HsTSF2HY59/GHWPhjwGrLa9S7dpsKeimPAUuS2QutnPtcsTgDcuqWodmcZtPp09NTyBw0lPphWk01078t54uL68XkNDwJM1vkbu/FBFww0SI814CvkaQmt8q9S6rrIrJEN9grH3dlw/Fp2fFp2bf+tKzK+HgTMlU54655cdH1UhWId3RXIN4HNJPG4tjLy4YZuNX56ysO/1aC3tLZ3T0WpZqzDcb1HXYqGTC3S+6q17mXYXLjm7+qhh28xnsN6knncQzKttD3CvZOgXt5e4O1Q/UmrvBbF9J1ZIPmE2V8ff0X0CT/Mw== sidebar_class_name: "put api-method" info_path: platforms/anchor-platform/api-reference/callbacks/callbacks-server custom_edit_url: null diff --git a/platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement.api.mdx b/platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement.api.mdx new file mode 100644 index 000000000..16763c5c6 --- /dev/null +++ b/platforms/stellar-disbursement-platform/api-reference/delete-a-disbursement.api.mdx @@ -0,0 +1,1148 @@ +--- +id: delete-a-disbursement +title: "Deletes a Draft Disbursement" +description: "Deletes a Disbursement in Draft or Ready Status by `id`." +sidebar_label: "Deletes a Draft Disbursement" +hide_title: true +hide_table_of_contents: true +api: eJzVWW132rgS/is6+tJ2jw0mQEj5RgO5zd00yQJtT7ebQ4U1Bm1syZVksizH/33PyIaYQN76sufeL4mxZp550WhGM15Ry2aGdj/TvjDTTBtIQFpDrzzKwYRapFYoSbu0DzFYMISRKiERkvQ1iyxRmgyB8SUZWWYzQ6ZL8kXwLzXqUZWCZghzyjdAvSoK9WjKNEvAgkZdVlSyBGiXCk49KlB8yuyc3tXptE9UROwcyJcqnBOq4WsmNHDatToDjxq7jBHSiCSNgXoU/kpjxYF2IxYbJAjnkDDaXVG7TB2l1ULOaJ5fIZpJlTRgcP0gCPDfPv/wbe9wsEzEhno0VNKipd0VZWkai9A5pP6nQebVrnA1/RNC5xiN7rOiEC34roJ3vTKeA8mk+JoBERykFZEAvXYU33Y7/MWcO7r0sPGas6N2xz/qHLT9Vtg+8l83m9wPGwcBa7WPIIjaNPfKnXmKDkj5qNgtd50jdo7eDkEsQE80zISxRfBMEjCGzWBiIUljZp+oRZgZqxKyZiKZAU6sIgYkJ0IuhHXoBt+t5ZoaQdYvHCKWxfYLKUUTYeQLSzTYTEvgNXIqnXXl8gtDym0mwr4wJFXGiGkMCM04d6SRimN1I+TsVqMF04JNYzBdslrVLvSMSfG3Uwr9kefkZi7CORHGAVTXncNQZiRmmQZOmOSIMay47UzI67sYsZDXZAYSjyVwPKqj/uXGKVY5orUzyEshScgMEDsXBiGksiTVYMrzX/GAVxjOMqsSZkXI4nhJWJqC5KiddbQg+avaVhB8UhmZswUQRlK2dKFww4RFL0VKk6XKSKRVst89NXIci/D6HrvdruJb0LUitCoRhbvFQjspomg3mkBmCabGwbve6Rn16OXbi/PB5Pz9uzeDIfWK15PeeX/ysXd2NhhPev3+cDAa3aHcR3HlUSusM76q9HGh0Bj1yD16w+IY7LdmhVv/thlnr4G3/Va7zfxW5+jAZwGA3zgMOocdCDhMGw+d7VukD2KqmbSkZ4wwFnnmKoGUzR7hm1ubmm69vij4WZrWQpUgv4F00ggmYSxA2glXCRPyYSyWCp/DoraLxQHSCQb35L5k/rhOdcNThEe8UAMekAmz+5AipRNcoZxZ8K1IYAv+IDho+kHHbzbGB0G3HXRb7dph6+h3BM5S/jOA89uo+liETu5RZsyPiKEoYhC2pk2/dTgN/BaftnzWClv+YdhsB0dBu9MJXH0IXU19LDP3UCniaKtC3o/6xwgijMlAPxWmoMYUq8GYLcD/vHnTb3VOTw7PPv7auey86w8+jI4/Djv9y/cfPzTPPzX7498GH07OWue9cav329vm72dnJ2e99g/a/QM/aI4buEPdduNH7fwuKC/uHt8DeliCtkvQfF8tHVmIY6aJCymyCaR1zLndcGfaXQEfyqj9Ye9kTD06HPT6n6hHR+PecDzoY+bsvR+5h+OLd5dnA3xZSZbV60Jx0UR5C9AiKq9Uk0hAvD+W17J748Hk4mTy5nQ4fks9+mnQG07eXZy7H5en59Sj573x6cV572xy2l+n+4oSHyriTpy0jc2TuTBW6WVFPtOaLfEaayExj5/DzICePHYYm1Gz3Zi+Bh94EPmtIGI+azZafqPVaXemrQPOioT+b28EBpexLEl/WHDnD4l8Wzh7IK1e0qdQIlEkYpg8XumqN1Y/gqkfNH1UsRaaH1Ub/qXsYJVl8aS8WFWDQUgLM9C712ZkIDJLpkXfsGGtSGsEO8gTUzY4z4Q3WRiCMVEW75V0tCsoYiIG/g2iCsb9Bu2K0YCXEfT98yVteO8VxhKV4Y2njLMnNnZORVLwbroqTowiEdNb4XAUBLUguA2AgucbpFhFprcdHN8S0gg2UtgCNLZnz5FT8qwlpaDX7rorxQm554jTPMel1r62/A3jZAhfMzDWI8dMYu9SlEvCtrpSYufMkjkzxFimrbOz0rT/Uv/lOX06aK2ecH/pF/MBwqYqK5sjx5ij9Vazx+uFs3zjqY1geioXLBbY4aZZ4cw1nKuPk0gpvNStn7Gt20xMvPL9lOkNzZRpIgG4KcOBSbI+Cnm+9n9j1//vJcvsXGnx98/x6NM9tVsMi9OKEGX7um/4c49/z5UlW5bdarGW0woaFeS7HAXyvlnQz5Lmtqi5u0UnSk8F5yB/yv7sd9+tzOe4YYvLmdPaNQctP1GZ/H8Nt2eGRVSaui8iWtWIGIJRmQ7BjW8KrrU4A2GmhV260esbYBp0L7Nz2v18hcPPBOxc4ei2SJxuWourtF5NoKa+EjyniKYX6zlupmPapRRR1kJGuAOFi6qibu/LqfgVljup8r8fx8XsDidCGNk42Sxc5BEjZhI4uRF2jplpMDpoH5JUiwXO165hieOmcqTcKw+F41xPl+fAuMtk+DtSTpuy0Kx7nq1B5WXMLN7GSO/ylLr+wxRaHtQatQB9kCUJwzZgq2/aj/Fy1L98hQmYEatUTKaZiK0zU1WGXS7xJuwayDSLrze3CjdbJDOtsrS4doQiFW5B4ezOVqRLsDdKX9f2VuL/LRX/kH/IcTltZJKoFKRfRm+qFR63olwLU6qiJLEqXU+b78B5bi6KCzhwICGTWMHcEXCMW2NZDakywiotwHRRD598NgVevfzvb/UGaekkf8rCa5D86uV6sDQTdp5Ni6HScxBedYkzfqPK0s2VmZDF+LYkc1YJGWlmrM5Cm+nSQNwX+9ie1p5hWaRdHv0e09YQj9l2A1Oypv1ma+YQJ344Z9qaB1Wu0NWtBqjjnb1evnjQnsfMeAtxQhyQ059DGqulm/o/etYyg3TX2RS0xC9utT8wTVnQibmIRqAXIqxOL0s1a0rP6o7IV5FvSjKPxiIEaVzVWCfAlIVzIAcuTxX5GbG69frNzU2NuVWHVrKa+tnp8eB8NPAPakFtbpPY5clUGZswWQGufCF0XwTvfOHbyjmr29L8PV8Wy5Jh4S9bT2OcHOelTauyRn3eauSxCesKjoOMuTIWl1erKTPwXsd5jq+/ZoBp+/OVR9ffZVwh48LgM998LrzXnJfD8h79ijz0fXKv6usSKLH+LVic4S/q0WtYFl9D8yscuRfVCtUqFnphCKmtsOzcH7bKeH+A4xzqUbZTea9d5S0fUMBeje7W0EIL/Jt797CsVkVdz/MNfbF0L0dp5cZ4NCLP838AieCGsQ== +sidebar_class_name: "delete api-method" +info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +Deletes a Disbursement in Draft or Ready Status by `id`. + + + + +
    + +

    + Path Parameters +

    +
    +
      + + + +
    +
    +
    +
    + + +
    + + + Deleted Disbursement details + + +
    + + + + +
    + + + Schema + +
    + +
      + + + + + + + + + +
      + + + + wallet + + object + + +
      + + + + + + + + + + + + + + + +
      +
      +       +
      + + + + asset + + object + + +
      +
      + + + The Stellar asset object + + +
      + + + + + + + + + + + + +
      +
      +       + + + + +
      + + + + status_history + + object[] + + +
      +
    • +
      + Array [ +
      +
      • + + + + + +
    • +
      + ] +
      +
      • +
      +
      +       + + + + + + + + + + + + + + + + + + + + +
    +
    +     + + + + +     +     +     +
    +     +
    + + + Bad Request, Cannot delete a disbursement that has started + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
      + + + + extras + + object + + +
      + + + +
      +
      +       +
    +
    +     + + + + +     +     +     +
    +     +
    + + + Unauthorized + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
      + + + + extras + + object + + +
      + + + + + +
      +
      +       +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +
    + + + Forbidden + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +
    + + + Not Found + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
      + + + + extras + + object + + +
      + + + + + +
      +
      +       +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +     +
    +
    diff --git a/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions.api.mdx b/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions.api.mdx index 5ad89b5dc..97328cad7 100644 --- a/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions.api.mdx +++ b/platforms/stellar-disbursement-platform/api-reference/download-disbursement-instructions.api.mdx @@ -5,7 +5,7 @@ description: "Allows an SDP user to download the raw CSV file that was uploaded sidebar_label: "Download Disbursement Instructions" hide_title: true hide_table_of_contents: true -api: eJzdWE1z2zYQ/SsYnJIZSnRctwfenNhp3XZST+S0B0cHkFyKiECAWSylKBr9986CpEx92B4naSftxdIIu2/37QLYB68lqZmXya280D5t0EMFlrycRjIHn6GuSTsrE3lujFt6oayYXFyLxgMKciJ3S2ucygWVIFAtxavJn6LQBgSVisRSedHUbAC5WJZgRYagSNtZcMgHIcfiptReLLUxwlmzEgjUoBUIvjHkhSoIUGjrCZuMc/KiVAsQKYAVikhlJeSckhI5qoJ2wWUkXQ2o2PEql4m86BIfsr4agMtI1gpVBQTI5VlLqyqQidS5jKTmitSKSrlfpqsL4YpAbogsI4nwsdEIuUwIG4ikp5VhPK+r2oCMJHyqjctBJoUyng2yEiolk7WkVR0sCbWdyc1mymi+dtaD5/XTkxP+2E1kGH7bFRnJElQeKK3lK2cJLI0utK+d163jPs5NCcGV6ffU2tZAvsXl+n4FoWibyk1Y2c+B4BPFmV98XZRNJLM2TFjtMZO1hE8qoCWyNTs7VtCXKhdv4WMDntt5D9JBdJd+gIwdauQNSLptGSA6PJIk8yFU/nGEwrmj/hV4r2ZwtAABvqO6zUFe2YUyOhe4JXeXQ4giU4VygLzvIQYnpY2i6troLJy2+INvt9W/ETn07sVh795Z1VDpUH+G/HtonidFzdDONlUK+GX9e+NI7NC7y6KPc3byYljFPY8n9eybRAt9+uGwT68dpjrPwf5zTTpew7vAT6nFjlfgdHbIiem/do39f268omN2bBecDXfBzjyyW88n771vEZBDesga1LQKs/0lKAQ8b6iUye2UB2wFVDoWCjMIVeRZn8h4KCp8vNb5Jta7qsEDLnrJ0KAJM2V6F27CrW57MQy6rbmq9W+wOpAVv/51w5orF4XDcJjAUlewSHg942G81FSyPrucnP74k6hRLxSBmMOKp3OnXs67cxg8eyHTSoJwNLQt2rGiKczDCYExCnfEjLg2igqHlTi/vpKRZLptlqfjF+MTrkFTVQpXnXp4GOPZ5OL6udBeKEHOGZE22lCg6XCmbJeqZ2VXqTmItDFzUatV6ECr92bompq1CUKmax0W3IIF6iC6BVo6nI8PSvv9pfjevrdBDOugt10NduRdgxmIGh2f61Zda9+l4qwgV/fqbA8uEsq2+jxzOYhMWZFCexiCI+s7x+KeVTlCUIIONfiE8xiJW9/ixd3naHgGRnVXpFGqsjnYfPqsJKp9EsczTWWTjjNXxU9CeJ60L4FtKivB16bSXOESRGcWWGlboGqPX4MdQe4LPdbT8ROYFRhu7a+h1kM8xm0Jqehtv5hNCaYaZaVC8g+mPLCLCQHiSmkbdz88yOcxGr+AqUQACvnnUBu36h99D5+1xrPdvEkBLRD48Xu+pgiw8n8UE8CFzvhe6ml1aY4dzuJgNHLFyHdmkTQ6A+vDDOkvwJofiuI03FPt/cxYSRwvl8uxCqsBrXP18e9Xry7fTC5Hp+OTcUmVCfdk7TxVyg6A+wflLq+9J+XOzbO+kwP//dd1N76CqqmN0pYlRajvuhuet3JneMpIJt1belCiaSRL54mt1+tUeXiHZrPhnz82wBPldhrJhUKtUp5Pt2sG5e/59gF4b42fve2e4M/Fva/0ozT60Wx5Li+UacJLMZJzWLX/ENhMN/3DOuTULpxnGdQ0cNlKvh2B8fPljYykOpAB8yADui+MejSN/YHehua/m+gel/W6FRmbzda+XbrXo6O2ZWyZ8WbzN2Svcd0= +api: eJzVV0tz2zYQ/isYnJIMJTqu2wNvTuy0bjupJ3Lag6PpLMmliAgEGGApRdXov3cWfJiSX3XTzDQXUUPu6/uw2MdWEiy8TK7lmfJp4zxWaMjLeSRz9JlTNSlrZCJPtbZrL8CI2dmlaDw6QVbkdm20hVxQicLBWrye/S4KpVFQCSTW4EVTswDmYl2iEZlDIGUWQSEfuZyKq1J5sVZaC2v0Rjikxhnh0DeavICC0AllPLkm45i8KGGFIkU0AoggKzHnkEDkDgraNy4jaWt0wIoXuUzkWRf4GPXFyLiMZA0OKiR0TM9WGqhQJlLlMpKKGamBSnlI08WZsEUAN7YsI+nwU6Mc5jIh12AkPW002/OqqjXKSOLnWtscZVKA9iyQlViBTLaSNnWQJKfMQu52c7bma2s8ev5+fHTEj/1Axu6HU5GRLBHyAGkrX1tDaGhypnxtvWoVD+1clRhUGX4PrT0azAe7zO8XAIqGUK7Cl8MYCD9TnPnVl3nZRTJr3YSvvc1kK/EzBGuJbMVO7iL0FeSCDxE9RUKZFWg1vBCjXNnz8iJ+wY9bQdn0I2acFrXjvCTVniQ6Z93t2A+T7AwJlPYCUttQOJFWccd0kAP/qKcAc4A9OJYXHS5l6obk2FyhUOd/FtbK5Oa/UF4MiR1171Nwg0wKThjE3PPNTJHLhzKEC3TMdEf2y9tkvzfQUGmd+isY/s8Z/edMSU9AzVjONFWKgewKvYcF3plsd/P71pLYQ3YTRe/n5OjlyPKhRmsZ6lqrLFSz+KNvr+3X8haO6LvbR/TGulTlOZqvcj5303fj8yk07GkFOCeP1Eum4Y1tzLeae0/MkaKDeld6nIzT4x1627gMhRm0ences8Yp2oRe+QrBoTttqJTJ9ZwbVoVUWm68CwwwuXcmMh43aR9vVb6L1X4X9uhWfQtunA41en7jbsZn0ZI1djqQArX6BTe3KujPf1zxDJOLwrqQ8GioIysSXi24ua0VlVywzmfH3/8gaqdWQCiWuOFu100Dp91dCZr9YNC22JDDyhQ2RKMo9JcZodbg9oYDcamBCusqcXp5ISPJcNsoj6cvp0fMQVNV4DZdN37YxrPZ2eVzrssgyFot0kZpCjCtW4DpQg31uIIlirTRS1HDJpxAOz8tnG1q7vUOM1Wr8MGueOAbeTdIa+uW01vU/v9C/GA+mDBcqjC/2hrNpMvj2lm+eO20qnwXijWCbN1POwfmIgGmnXczm6PIwHBjC5chKPK8ZHlY5inXYZisrFPoE45jIq59ay/unpPxHZjUHUmTFLIlmnz+rCSqfRLHC0Vlk04zW8VPsvA8aSfrIZSN4JIGihkuUXRiAZUyhYP2+jWuA8jnQo+d6fQJyAoXKuqXQOtNPIZtjanoZf81mhJ1NclKcOQfDHkkF5NDjCtQJu5ePIjnMRg/oa5EMBTiz7HWdtMvUQ/ftcaz3LJJ0Rkk9NMPXKYIXeV/K2boVirjutTD6sKcWreIg9DEFhPfiUVSqwyND/2jL4A1L17iONSptj6zrSSO1+v1FMLXYK1T9fGvF6/P387OJ8fTo2lJlQ51sraeKjAjw/2Cto/rYEXbqzzbm1b97W+rXfsKW0qtQRnu+YHfbdc8r+Ve85SRTLrddETRPJKl9cTS220KHt87vdvx608Ncke5nkdyBU5Byv3pestG+X8+LFT3cvzsXTf5Pxf3br13wuhbs+G+vALdhM0rkkvctAv2br7rF9UQU/vhNMuwppHKsMLtDRg/nl/JSMKtMWAZxoDuD1u9M4zDht665t9ddI/KdtsOGbvdIN9+ulejgzYgNox4t/sbFvwyRw== sidebar_class_name: "get api-method" info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api custom_edit_url: null @@ -211,7 +211,7 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating
    - Bad Request + Bad request, invalid request parameters
    @@ -220,8 +220,8 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating schemaType={"response"} > - - @@ -315,63 +306,7 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating value={"Example (from schema)"} > - - - - - - - -
    - - - Schema - -
    - -
      - any -
    -
    -     - - - - - @@ -397,8 +332,8 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating schemaType={"response"} > - Not Found + Disbursement Not Found
    @@ -703,8 +638,8 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating schemaType={"response"} > @@ -844,7 +779,7 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating value={"Example (from schema)"} > @@ -854,7 +789,7 @@ Allows an SDP user to download the raw CSV file that was uploaded when creating value={"Example"} > diff --git a/platforms/stellar-disbursement-platform/api-reference/export-disbursements.api.mdx b/platforms/stellar-disbursement-platform/api-reference/export-disbursements.api.mdx new file mode 100644 index 000000000..cfb54fa6f --- /dev/null +++ b/platforms/stellar-disbursement-platform/api-reference/export-disbursements.api.mdx @@ -0,0 +1,484 @@ +--- +id: export-disbursements +title: "Export Disbursements" +description: "Exports a CSV file of disbursements." +sidebar_label: "Export Disbursements" +hide_title: true +hide_table_of_contents: true +api: eJzNWNty2zYQ/RUMnpIMJcpumge+qZHcpk0aT+S043E0GZBciohIgFks7aga/ntnQUqmfJEvcWbyYpHEYvecXWAvXktSCyejMzn9VlkkJ+eBTMElqCvS1shosyCUeD37R2S6AGEzkWoX1+igBENuKANpK0DFW96kMpLgN036QjKQlUJVAgGyxbU0qgQZya8ykJotfa0BV/Kq/bFwoDDJBQGWonaQCrLCywrK0daLXFAOO4gEq/awEL7WGiGVUaYKB4F0tCrYamaxlAEDLWwKMiKseTXJoVQyWktaVSzmCLVZyKYJtngdKardftDTbyohUSpKcmGNx9duY99dRfuEOAMJpi45npMP46MTGcgP0/HkVAZydjL+cDKdyEAejz/O/MPr9++O30754zyQpMnb68ds1jJt2Lwqq3bd6+25I0FQBOlnRZ9VRoD7HfPeFCuBQDWa3TMkKFckFILoFAqvTVCunUgVwVAcWSwVReL09PR08O7dYDJ5wgD3OR6ORq8Go4PB6PAWojFkFuHJmLbqfiKqziLtZ3ekoUi3t5Hld0k+5ZFOIVN1QTsh6J10jznor8371zXVCIlHvZfQZCMmMouekDaL62nuB5BSLumxad8YG9OYs0VXWePAsZbD0Yh/dqHfmpfZK9YQGPII4BuFiTvn59txZf7kyUjG2ihcyaZpmkC+HB1ct/vRqJpyi/o/SHdNvQhf3GjFxl8g4dhVyPWCdMsKEC3eclAJlbtbQ5eTL+VMXcaArKIE59QCbsrpTf8qbGHIvy2JHWaXKDZ2Xo4Oepqv7mg1q6oqdOJrYvjFscfWP8yaD9Ev10N0ZDHWaQrmh8TnZvdd2nyIG3Z28T4HSY2aVr5V+A0UAo5rymV0NudrUQLllluNBXjAipdk2DYeLrx6Dxzg+abvqLGQkZSsZWNkxp5oyfZNbRmrSv8F15PGn/+etDmQcwaHBAx1XAPh9MJAKi405UIZMZ0d/vpKVKjPFYFYworTSZejxl00VT9P5aBSPsINv2fWo+mK9IygKBSKfrEWx4Uivr1ifPxGBpLptigPhwfDEfugLku+0pE8yUHs1/FsNjl+LjS3fWRtIeJaF+RpWlwo00F1nPxLtQQR18VSVGrVVTgrlFigrSvOSQiJrrRfsOe+pF9aN0AXFpfDa679+SB+Mp/MCZdoNmmErcAMnK0xAVGh5YvTVnbtOijc+Nlq0/FdURcIZVK/kNgURKKMiEFktjbppmPMbFHYCy5DCJV1mixqcBHjGIgz1+oLu99B/8QPqs5Jg1glSzDp/FlOVLkoDBea8joeJrYMH6TheSQ8+S2UleCEojR7OAfRiXlW2mSoHGGdUI0dQY4L3RXT4QOYZejz2fdQ26i4i9sFxGIj+2g2ORTlIMkVktsLuScXEgKEpdIm7D7s5XMXjT+gKIVX5PGnUBV2xcfrTiaidiy3rGNAAwRu+InTFE9k7n02AzzXCeelDa0O5tDiIvRCA5sNXCcWyEInYJxP/5sEWKkkB3Ho81Sbn1lXFIYXFxdD5Ve9tm6rC9++eT39ezYdHA5Hw5zKwufJyjoqlekpbqdXcXUS3ck168vSeN9ptysLvqWqCqUNdxoe97orRWfdDOyt7VifBzK3jlhkvY6Vg49YNA1/bjtTLlGpdiouem3mrYC/bzy+kccSVt1Yfq6KGnytDB6C6cHT7x4Y22n7kViefODcg/WGUfjHo77n8Hg/2NvB9pG47zEW7ot1O3Y+0vY9J7g99vuj4iWIOb+gZhS++Qw2nRlf1HbjOEmg6kPfzlo7rervU/6PjLrWWi59a9k9sNbNkln1dF5tElvT/Jf9dOOW9bptXJtmK98u3bqjo7aRZu/Mm6b5H3hhCE8= +sidebar_class_name: "get api-method" +info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +Exports a CSV file of disbursements. + + + + +
    + +

    + Query Parameters +

    +
    +
      + + + + + + + + + + + + + +
    +
    +
    +
    + + +
    + + + CSV file of disbursements + + +
    + + + + +
    + + + Schema + +
    + +
      +
      + + + string + + +
      +
    +
    +     +     +     +     +
    +     +
    + + + Unauthorized + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
      + + + + extras + + object + + +
      + + + + + +
      +
      +       +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +
    + + + Forbidden + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +     +
    +
    diff --git a/platforms/stellar-disbursement-platform/api-reference/export-payments-csv.api.mdx b/platforms/stellar-disbursement-platform/api-reference/export-payments-csv.api.mdx new file mode 100644 index 000000000..2294982f3 --- /dev/null +++ b/platforms/stellar-disbursement-platform/api-reference/export-payments-csv.api.mdx @@ -0,0 +1,484 @@ +--- +id: export-payments-csv +title: "Export Payments" +description: "Exports a CSV file of payments." +sidebar_label: "Export Payments" +hide_title: true +hide_table_of_contents: true +api: eJzNWG1v2zYQ/isEP7WFZDle6m7+5sVOl61NgzrpEKRGQUkni7VEqkcqqWvovw9HyY7cOM7LEqBfYkl3vHueI3kvWXIrZoYPLvj4e6HRGj71eAwmQllYqRUfrARMsIPJJ5bIDJhOWCEWOShrOtzjugAUpH0U8wEHp3/SyA8mn7jHC4EiBwtIrpZciRz4gBsrbGm4xyX5+VYCLvhN7yKyLBc2SplWzKbA6mUEgt4aIIQD4VspEWI+SERmwOPGLjJylGjMuUfIMh0DH1gsSRqlkAs+WHK7KGo8KNXsBoTT23ySSVXmFL3Rx+HhKff4x/FwdM49fjI+Hh0dv6Wn4dlkPOIen5wdHIwnE+7xw+HRO/fpYHh8MKbHqcettA5rE7hJHZuKUIu8cKLaSeWtA4gQgbwE/CLj3VE8OzsaMZsKyxAKBEM7wwRbrWeyjmwsrAiFgaeL5Qb+sB/2+29E7PejqOfv96PE/yOEN/7r/l4sRARv4v3f2/QiBGEh/iLsF5FYwN0cP6hswRBsiWp9OmvOAoE1tpgzxGwqDbGFDjvUmAs7YOfn5+f++/f+aPRM7Hvdbt/v7vnd3i0cQ0g0wlOQrC39QiyNRrub2KGELGalgZhZzUh/I8U84dVORJnZjci37nHr47RqEYglQuSg7mQxWqmxRKNjIdXsuYkIE7UY1G8EixhMyaMptDJgyEqv26WfTdTb8jr3eKSVpSxHzuG7DSJzSc+3Q0rcIaOLLpXABa+qqvL4fnfvpsszJUqbapQ/IN509Sp4tdWLDr9CRFtVINUbK2tCgKjxljNpUZi7LTRV6FpPlXkISCZyMEbMYIt5x2x96tcw+LG2bIPZNYqVn/3uXsvyzytqy6IoMhm5mhp8NRSx5bN5c1v0280tOtQYyjgG9Sz7sz181z4fEoaNVbTOQFSitAvXbPwJAgGHpU354GJKNyIHm2pqVWbgAAsS8aBuXEzQugIG8HLVtJSY8QHnZGBlf0JBqHm2vazJikL+AzezxN//ntaZjpIE7QYo29D0mJEzBTG7kjZlQrHxpPe6zwqUl8ICm8OCkkiTlIbNRop2YkpBxHR6K3pPtEPTtBYTC1kmkI2kCUs0QCzZSSYsXVw2PDniHie6NcpeZ6/TpRiUeU63uW6Edtt4MRmdvGSSegurdcbCUmbW0dQ4E6qBaijF52IOLCyzeauOaSbYDHVZUCZCiGQhnUBfupp97V2BvdI472zt1X4tiJ/VZ3VKhZhcKqYLUL7RJUbACtR0Z+r6LU0DhbpcXaxazZ/MeUyo2AkiHQOLhGIhsESXKl61x4nOMn1FdQeh0EZajRLMgHD47MLU9oLm149bQfKLJkh+KKI5qHj6IrW2MIMgmEmblmEn0nnwIAsvB8yRX0NZMMolQlKEU2CNmmMlVYLCWCwjW2JDkPbF3rWnnQcwS9Clsv9DbWXiLm5XELKV7qPZpJDlfpQKtGYn5JZeYBEgyIVUQfNhJ5+7aPwFWc6cIYc/hiLTCzpedzJhpSG9eRkCKrBgOp8pTVnA3HxIJoCXMqK8tKLVwOxonAVOydeJbxo1j2cyAmVc5l8lwEJEKbCey1N1fiZbgyC4urrqCCd11pqlJnh3dDA+noz9XqfbSW2euTxZaGNzoVqG65mXnVxXgo00s7wuiPcYj5ti4HqoIhNSUWvh0C6b2nPRDM3GVaPG59TjqTaWpMslTWVnmFUVfa57T6pJsTQizFrd5A6Y95+jtwKew6I9sl+KrARXD72HwHj4ILoDzOb4+0hETzk27sC6ZZZ9VsD3HAHvh3g9mT4S8h3D3a7zVg+Oj/R79zi2w3V75Lv2P6UXlATAtZPequGi61gvHEYRFG3U6+lpo/l8O6Z/GIkbHePcdYzNA1ldidSiZfPn3q92TX8pRFuXLJd1P1pVa/1adOuKhtpKm6IzrarqPxK+AXI= +sidebar_class_name: "get api-method" +info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +Exports a CSV file of payments. + + + + +
    + +

    + Query Parameters +

    +
    +
      + + + + + + + + + + + + + +
    +
    +
    +
    + + +
    + + + CSV file of payments + + +
    + + + + +
    + + + Schema + +
    + +
      +
      + + + string + + +
      +
    +
    +     +     +     +     +
    +     +
    + + + Unauthorized + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
      + + + + extras + + object + + +
      + + + + + +
      +
      +       +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +
    + + + Forbidden + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +     +
    +
    diff --git a/platforms/stellar-disbursement-platform/api-reference/export-receivers-csv.api.mdx b/platforms/stellar-disbursement-platform/api-reference/export-receivers-csv.api.mdx new file mode 100644 index 000000000..732200d18 --- /dev/null +++ b/platforms/stellar-disbursement-platform/api-reference/export-receivers-csv.api.mdx @@ -0,0 +1,484 @@ +--- +id: export-receivers-csv +title: "Export Receivers" +description: "Exports a CSV file of receivers." +sidebar_label: "Export Receivers" +hide_title: true +hide_table_of_contents: true +api: eJzNWNtu2zgQ/RWCT20hW0622we9eWsnm912W8RpiyA1CkoaWawlUiVHdr2G/n0xlGTLieNcNgH6ElnicOacGXIuWXMUM8uDKz7+WWiDlk89HoONjCxQasWDdoEJ9nbymSUyA6YTZiACuQBj+9zjugAjSPws5gEHt+G8FXg7+cw9XggjckAwZGzNlciBB/wH97gkIz9KMCt+3fSQWRAmShmCyVlpIWaomZNlmBpdzlKGKWzAsCLVCr6pMg/BeAxyITOPCRWzsxHhNPCjlAZiHiQis+Bxi6uMcCTa5Nwj5JmOgQdoSlqNUsgFD9YcVwWJWTRSzXhVeRsGFgWW9jCN8U8RIcsFRinTyiGut5Ejd/AvRZYBPiFUj4Mqc4rv6Hx4csE9fj4eji7d8/RscjE+H4+4x0/eDU9PxyMKPkp0djbx++IwTWqeFVkWeeFEapUdZ0QGBEL8TeA3kSCYw275oLIVM4ClUdvjxDAVyIQB1ihjThPDVFoWC4Q+O9EmFxiwy8vLy977973R6AlD2+V3PBi86Q2OeoPjW0iGkGgDT8KyVvUL0bTa4GFmJxKyeHMrSX5L8ClPcAyJKDPccX3nYHc+Trs3M5YGIgf1IItRK8YSbRwLqWa76e0ZmAgbdSjUb4SLKEzJoi20smBJy/FgQI9d2HtzMfd4pBWCQmcdfqIf2QX9vh1T4o4ZD3golTArXlVV5fHXg6ObNj8pUWKqjfwX4l1Tr/xXe63o8DtEFKzCUI1AWTMCY7S55VSiEfZuDU3a3crVOZ9U5GCtmMG+tF11z/0GBv9HI9thtkXR2nk9OOpovr6j1iyKIpORq4P+d0seWz+bNRei326G6ESbUMYxqGeJz373bW0+xA07u2ifhag0EleuP/gDhAEzLDHlwdWUrkQOmGpqL2bgAAta4n7dbFi/ewcsmEXbaJQm4wHnpKE1MCEv1ES7ZjZsRSH/hpuJ4q8vF3WyozxB4QCFDU+PWTlTELOlxJQJxcaT49/fsMLIhUBgc1hRGmny0rCJpOjmphRETMe3ovdEOzRNIZ4gZJkwbCRtWBoLOShkHzOBdHPZ8OMZ9zjRrVEe94/6A/JBmed0nQN+kQI7rOPFZPTxJZPU4qHWGQtLmaGjqc1MqAaqpSyfizmwsMzmrBAr0uK+CjYzuiyaXCQL6Rb0wtXtrXUFuNRm3r/h2l8P4lf1VV1QLSaTiukCVM/q0kTACqPp0tQlXNoGCvV1umgbumvq6h6UFiIdA4uEYiGwRJcqbhvCRGeZXtalp9BWojYSbEA4euzK1vr85tmLO07qFY2TeqGI5qDi6YsUsbCB788kpmXYj3TuP0jDy4A58hsoK0bJREjycAqsEXOspEqMsGjKCEvTEKS44F0x7T+AWWJcLvs/1FoVd3FbQsha2UezSSHLe1EqDNqDkDtyPhoAPxdS+c2Hg3zuovEnZDlzihz+GIpMr+h43cmElZbk5mUIRgGC7X+lNEUjmP2QTMAsZER5qaXVwOxrM/OdUE8nPduIeTyTESjrUn+bAAsRpcCOXZ6q8zPpCnx/uVz2hVt12pqt1n939nb8z2TcO+4P+inmmcuThbaYC9VRXE+q7LxTCnbyzHpbEu8z1TblwLVRRSakou7C4V035eeqmXXrdre1OvV4qi3S8nodCgufTFZV9LnuQKksxdKKMOu0lLcCfeoZeC+rOayaaXwhshJcxfQegvIxI+4BJJup+pFwnnS0PIBzz8D7vIjvOSbeD/JmfH0k5jsGwEPxrYfLR9q9x8h2wHZ3LtwCmNKLkYTAdZxe25LRba03DqMIii7szYC105+ejunfLOJGTzl3PWXzg7S2S2rV0Xm9O6xN01/y0d4t63XdsVbVRr5eunVHQ62VJu9Mq6r6D9uw+Rc= +sidebar_class_name: "get api-method" +info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import Heading from "@theme/Heading"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + + + + + + + + + + +Exports a CSV file of receivers. + + + + +
    + +

    + Query Parameters +

    +
    +
      + + + + + + + + + + + + + +
    +
    +
    +
    + + +
    + + + CSV file of receivers + + +
    + + + + +
    + + + Schema + +
    + +
      +
      + + + string + + +
      +
    +
    +     +     +     +     +
    +     +
    + + + Unauthorized + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
      + + + + extras + + object + + +
      + + + + + +
      +
      +       +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +
    + + + Forbidden + + +
    + + + + +
    + + + Schema + +
    + +
      + + + +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + + + + +     +     +     +
    +     +     +
    +
    diff --git a/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers.api.mdx b/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers.api.mdx index d8bfc5cbd..7d22a3d67 100644 --- a/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers.api.mdx +++ b/platforms/stellar-disbursement-platform/api-reference/list-all-disbursement-receivers.api.mdx @@ -5,7 +5,7 @@ description: "Fetches a list of receivers within a specific disbursement using t sidebar_label: "List All Disbursement Receivers" hide_title: true hide_table_of_contents: true -api: eJztWm1z2zYS/isYfrhp5kSJ73qZ6dwplpw4sR3HsuM2qUcFiaWEmG8FQDs+j/77DUBSoixKtmO31970i2WSu4tnF4vF7gJ3msAzrg2+aCPK/ZxxiCERXLtsaQR4wGgmaJpoA20fRDAHjjCKKBcoDRGDAOg1MI5uqJjTBGHEMwhoSANEasJQzmkyQ2IO66/Rr5SgX9vobE45goRkKU0E4nmWpUxwlOEZTbAcva21tDQDph4OiDbQDikXwyiqQz6t0GgtLcMMxyDkw+DLnZbgGLSBRonW0qjUJcNirt1X8GAklZIo62K1lsbgt5wyINpAsBxaGhe3kZTHaZxFoLU0+JZFKQFtEOKIS4JgDjHWBneauM0UpWA0mWmLRWsJJsMzqOD8lgO73cBzNgdpA0BJHvvAkEhRKOegvQapGrLEFKYsriMqEd8HVIjcADSNaEzFw7BKRIUPpIxwCY6ByFmCMmAK9ovCvJSyeJYmHLj8bhmG/FlHNlx6Zn0CUd0xgjQRclIHdxrOsogGyqU6X7kUcLcJIPW/QiANkjHpgIIWw69c82HaBL6JTVeQumPlPgPtX9JcP9r/WM3Aj5a2kHLg+jGc5iYnnhWDl6w0ETADVuftLVqaSAWOdpOZ3kISUqHGO1npvWhpBIu6rTBjWLoLFRDzh+1CyW7dILCx2w0M3fU8Q3d8F+s47Ho6DjAJur7R9/u2RAExptFuUVWg+rckbadspmw0TxOYlh62k/2fpuu6lu31nK6rRvwmgCU4mj6kQs6ZafUNw5RcFYjpDY4iEM83UM+wDdskjm4Sw9GdXrev+x7p6yRwPccM+/1eD+oDP39Ew+qDBcTQQ/A93QkcQ+/5Tlc3eraHe27XMbGl1f2lWnqHVCgoL6W6iwnuA3F1x3Wx7nR7lo4NAN30jK7XBYOAr2xehLZdkj5Rn+FEoCHnlAvJM09jUMF5J99ciIwPOp3rgh9nWTtI4zXlL5SylepcQBRhNsWEMOB8t/Q3ez8N39k/vbM/vbff7b+1Px6N9j9M3h9Zx0dHn19PPtifDs688fnJx4vJ6MJ613WOLPv0dHJYHyiGOG3YgtYJpsXXBqqAARZApviB4GUZlq0blm7YZ6YxcNyBa7YNw/gsZeQZebYMmlzTJ8nob8qIMBfTGDiXYZJDIrZIW99OBI2BCxxn6GYOiUoMqqWEpMTqiSCcIAVTRUaE/TQXSMikpvT3JpymsYlTxeNphm+LFGy3vkWcL0inFZRH8ISYRkAeOYpRBJAY04Qms6cxFYimOE7zdZYnbhSYcxDTQOUJu4Y9n4z25MgFPeU8fyiwv3n9euR0D/a9w4v33ZPu0Wj8abJ3cdodnZxffLKPf7ZHZx/Hn/YPnePhmTP8+Nb+fHi4fzh0G/TbPZBpGG3DWIsOw4JtoRYkFnmzTZM8Vqn56XD/TGtpp+Ph6Gf1++ZgcjY+HY+0lrZ/OHzzZjySGfv9uMuLGDQpBlgONZ1TLlJ2+/1z8gdCXi7DptFkHinXssxFQJekDy22z40b1NqobwvrjBPBbrVFE3lBXVuBz9/SCAktK3Rd3bbcvu70LEvHDlh6AIZp206/3w0d5d1b3W0zTS9oq6qmgtrkmKtdQTCccBxIKVvym81xVpVTjRvRImZOCsEoAXGTsqs2OhAowAnyAeUcCBI0lWzBVR3kFuaykvxSvT7EfsqwnKzLH6odOVq+a5c6yYyv86qFUrbkHH+TU7NiqihBve+8aq8HNN+2+8QMen1im47Z8/ye6XQDC4dO0FeJiO8TPyBdTHCPmHbPs+2+0fWcvq+2UsqCCArLhsCmsioCLh5t3j3Fjyp+VPKjg5EyJuUoTaJblDGQe9tqt6pseYM5ijGB0nqFuHUNuw72er6HdTv0urpjOb7u93xDB7dvY7NPuo5n171kWY03KrEzpm3qV9A2uOmWUHIyPh4dHL+R/w3PJyqgTM739saTiQwtw4PD9chyUgh8QhC8V1YmCM9mDGYyl1mWmDEILAsgVKx3jmRpWWyTSo1iENkvSUixNJbpRBou54gvtQ/mOJkBR2kQ5IwBab9EMP7T2LpMvhpd5SUCfC1zXA/wa4DWA/tuIlXg1vtA3xnhN6cgT+hvOSBKIBE0pEUf5X5zrK56nqvO1UrrwDV9bBJXdy1i645phTp2+4HuQWhbxO1j37F3lT8NDR0cwxYYtS2q9kH/miegW/3da32bV03OhqdnypmWXrX34ejkcHy27k71Ps7Kp3aXJpvKKXq5I60twV0W3+Vsnm4bZ4Y5sKyB2233bLPfdR9R7WzCUjVEwfTyyHpt2/Rc895qqNuzKkxVuvz8/CUMMQSOb+uO5xu6Q3xHx07g6F5gu0bPcLtdQ+XN2/L4ezFXgkKKtinF357cN4kpqFFVeb9UBbDbDb8rcD3kRN8plEAEzxTqlULdVYjd9OgqLVMuhZaOtCx5lKf93Qr7uxX2B7XC/iw9rD+sWt5aqlam/6vErM3k7C+KvumEcr2n0ERRP2dRxI5hbp53nSc4F/OU0f8AebmzLWAsbdhai3MPhr+nHqmO8Vra9jpAqbk07BKGdpwKtKbmCkU1jmOYNcn3OX5PwcXU2JtTs58ynxICye8/L83arQA8gqBQw9lUQ2q8n+bJ/7d7haWGTQ7g1B1g7Vg5WXL+zrKVeA5Bzqi4VfcZXgNmwIa5mGuDL5fycDwGMU/lxYiZOm5Q9xsGWqdeRfDOHSWLDqudhnNg19UdiZxF2kDTpLBqrImc0sLm9RFX7ZKMvofNfsm7i7OisxemTK0XWecW3tJCnM4SIOrCiDw2GU8s10MZo9eyCrqCW9n2KC8kDMulVsTB8k7CHDApLi5oNAmLA64ykFbZ55olTyIsZAxHw5MDraVJdQuUVttsG9IGeRxj2QVay2CbZfwwGZ28kv02jESaRsjPaSSUmimb4aSEqi5DxPgKkJ9HV1WPRb3FaMbSPCsvTtCMqg+pPFFqapU2lo1/Loi/JL8k6v6OHDJBaQaJztOcBYAylsr1i8QcqyZlAUWW4emyzL0nrrXslsnSr2oTq5WgGOfyIYrSG9llY5ClnIqUUeADiUNHX8rUsurn6msti6w0ku7j4AoSsmr/zqiY575MWztPkvBqUFxeWkK5rdqAXIEtyZRWNAkZ5oLlgchZqaCcF/HQnLafoFnIVJR+jmqViId0uwEfVbTfrc0colgP5pgJvhNyja4jGEBHnkh2yhc79XlIjbcQxUgJUvgJZFF6WzVxd6+1op1+lfvAEhDA27/IMCWAxfxDOAF2TYN6fVQ/jVBEehrqvCRraRENIOFqA6kCYIaDOSBLxakiPktZg07n5uamjdVXJa1k5Z3Dg73x8WSsW22jPRdxpOJklnIR46QmWN6eQ8Mo2n5Pai3s3K32/v/1LcBy5xHwTXSyCFN1D0mZ5q7c9L6stSmlLgPVPV3te5eysOVCkt7d+ZjDOYsWC/m6uPAmd0NCOfaj2sW1rQbZdUuvEe0V3K6u/13jKAe177aeOuhj7+A9AGJ55W8F5VI+MCqxPNEYP5yWF/5eoa23KRvxVBlFcltHUuGkRFtcyn5EsflLTMWHYRBAVge/kZmuJUdvxrLGxhtZzJXKYsp/pPRGOPfzkQKC/Csnr5Hl7q7IkRaLJX3xaStHqeJSc6nBYrH4L01hrGw= +api: eJztWutz2zYS/1cw/HDT9ESJbz1mOneKJTtOZMex7LhN6lFBYimh5qsAaMf16H+/AUhKlEXJcZL22pl+iSNyH79dLBe7CzxoAs+5NviojSj3c8YhhkRw7bqlEeABo5mgaaINtEMQwQI4wiiiXKA0RAwCoLfAOLqjYkEThBHPIKAhDRCpCUM5p8kciQVsPka/UIJ+aaOLBeUIEpKlNBGI51mWMsFRhuc0wVJ7W2tpaQZM/Tgm2kCbUC6GUVSHfF6h0VpahhmOQcgfg48PWoJj0AYaJVpLo9KWDIuF9tjA45E0SqKsi9VaGoPfcsqAaAPBcmhpXNxHUh6ncRaB1tLgUxalBLRBiCMuCYIFxFgbPGjiPlOUgtFkri2XrRWYDM+hgvNbDux+C8/FAqQPACV57ANDIkWhXIP2BqRKZYkpTFlcR1QifgyoELkFaBbRmIqnYZWIihhIGeESHAORswRlwBTsbwrzWsriWZpw4PK9ZRjyzyay4Soy6wuI6oERpImQizp40HCWRTRQIdX5lUsBD9sAUv9XCKRDMiYDUNBC/To0n6ZN4JPYDgVpO1bhM9D+I931g/2v9Qr8YGlLKQduP4fT3ObE80J5yUoTAXNgdd7esqWJVOBoP5npLSUhFUrf2druZUsjWNR9hRnDMlyogJg/7RdK9tsGgY3dbmDorucZuuO7WMdh19NxgEnQ9Y2+37clCogxjfaLqhLVfyVpO2Vz5aNFmsCsjLC97P82Xde1bK/ndF2l8ZMAluBo9pQJOWem1TcMU3JVIGZ3OIpAfL2DeoZt2CZxdJMYju70un3d90hfJ4HrOWbY7/d6UFf89RoNqw8WEEMPwfd0J3AMvec7Xd3o2R7uuV3HxJZWj5fq05tQoaB8K9NdTHAfiKs7rot1p9uzdGwA6KZndL0uGAR85fMite2T9J76DCcCDTmnXEieRRqDSs57+RZCZHzQ6dwW/DjL2kEabxh/pYytTOcCogizGSaEAef7pR8d/Dh8bf/42n7/xn59+Mp+dzI6fDt9c2Kdnpx8eDl9a78/vvDGl2fvrqajK+t11zmx7PPz6aSuKIY4bdiCNglmxdsGqoABFkBm+InkZRmWrRuWbtgXpjFw3IFrtg3D+CBl5Bn5ahk0uaXPktHflhFhLmYxcC7TJIdE7JC2uZ0IGgMXOM7Q3QISVRhUnxKSEqtfBOEEKZgqMyLsp7lAQhY1Zbw34TSNbZwqH88yfF+UYPvtLfJ8QTqroHwGT4hpBOQztRhFAokxTWgyfx5TgWiG4zTfZHnmRoE5BzELVJ2wT+3ldHQgNRf0lPP8qcR+9PLlyOkeH3qTqzfds+7JaPx+enB13h2dXV69t09/skcX78bvDyfO6fDCGb57ZX+YTA4nQ7fBvv2KTMNoG8ZGdhgWbEv1QWKRN/s0yWNVmp8PDy+0lnY+Ho5+Un+PjqcX4/PxSGtph5Ph0dF4JCv2x3mXFzloWihYqZotKBcpu//yNfkTIa8+wyZtso6U37KsRUCXpE99bB8aN6gNra8K74wTwe61ZRN5QV37Ar9+SyMktKzQdXXbcvu607MsHTtg6QEYpm07/X43dFR07wy37TK9oK26mgpqU2CudwXBcMJxIKXsqG+29aw7pxo3okXOnBaCUQLiLmU3bXQsUIAT5APKORAkaCrZgps6yB3MZSf5sXo8wX7KsFys6++qHTlaPWuXNsmKr/OihVK24hx/kkuzZqooQT3vvGhvJjTftvvEDHp9YpuO2fP8nul0AwuHTtBXhYjvEz8gXUxwj5h2z7PtvtH1nL6vtlLKgggKz4bAZrIrAi4+270Hih9V/KjkR8cj5UzKUZpE9yhjIPe29W5V+fIOcxRjAqX3CnGbFnYd7PV8D+t26HV1x3J83e/5hg5u38Zmn3Qdz65HyaobbzRib07btq+gbQjTHankbHw6Oj49kv8bXk5VQpleHhyMp1OZWobHE/XoYHh6MJ5sJpmzQvYz8uGjDjNBeD5nMJdlzarbjEFg2Quh4tPnSHaZxY6pLCqUyNFJQoqvZFVZpOFqufjKEcECJ3PgKA2CnDEg7W+Rl/+Kbi9LssYA+hZpv1ZPbqb9DUCb6X4/kWp769OhL8z726uRJ/S3HBAlkAga0mK68nhkVjc9z9U8a2114Jo+Nomruxaxdce0Qh27/UD3ILQt4vax79j7mqKGMQ+OYQeM2sZVe6H/miegW/39GWBXgE0vhucXKohWAXbw9uRsMr7YDKf6dGcdU/sblm3jFL3cpza+xn0e3xdsnm4bF4Y5sKyB2233bLPfdT+jB9qGpTqLgunbI+u1bdNzzUdfQ92fVbuqiuivr2rCEEPg+LbueL6hO8R3dOwEju4Ftmv0DLfbNVQ1vau6f5R+JSikaJsK/90lf5OYghpV/fi36gv2h+EXJa6ngugLhRKI4CuFeqVQd51ityO6KtZUSKFVIK0aIRVp/wzI/hmQ/UkDsr/KZOtP66F3NrCV6/8uOWu7OPubom86t9ycNDRR1E9fFLFjmNunYJcJzsUiZfR3IJsnXt93vn/OIRcwljbspsUBCMNf0o1U53ktbXfpryxb+XIFQztNBdqwbI2i0uMYZk3yY45CctOx3x+lTS2Rvb1EhynzKSGQ/CHr0+y+tc7nuGGDS5njbJsjLT9M8+TvGm7PDIuwNLUpIpx6RJwDT3MWAEpWXJU6DkHOqLhX1xNeAmbAhrlYaIOP1/KsOwaxSOU9h7k6PVDXFQZap17+884DJcsOqx1uc2C31ZWHnEXaQNOksErXVC5E4am6xvXII6NvYHvm8frqohjUhSlTAS4b1MJTLcTpPAGi7n/IU5Dx1HI9lDF6K9uXG7iXo4vyfsGw/DaKBFZeMVgAJsU9BI0mYXFeVWbAqmzcOMs/i7CQyRcNz461libNLVBabbNtSB/kcYzlJGej9GyW8d10dPZCjs8wEmkaIT+nkVBmpmyOkxKqutsQ4xtAfh7dVHMS9RSjOUvzrLwHQTOqXqTygKhp8tnY7/21IP6c/Jyo6zhSZYLSDBK9DOKMpfKrQ2KB1cyxgCL753TVnz4S11pNvGTPVk191ZegGBfyRxSld3JSxiBLORUpo8AHEoeOPpY1YTWe1TdmDVnpJN3HwQ0kZD3NnVOxyH1Zb3aeJeHFoLiLtIJyX43yuAJbkimraBIyzAXLA5Gz0kC5LuKpNW0/w7KQqXT6NaZVIp6y7Q58VNF+sTULiGI9WGAm+F7INbqOYAAdecDYKR/stecpM15BFCMlSOEnkEXpfTWI3f+tFdPxm9wHloAA3v5ZpikBLOZvwymwWxrUG5v64YIi0tNQ5yVZS4toAAlXm0eVADMcLABZKk8V+VnKGnQ6d3d3bazeKmklK+9Mjg/Gp9OxbrWN9kLEkcqTWcpFjJOaYHkZDg2jaPe1p42087DepP/fl/rKnUfAJ9HJIkzVtSLlmody0/u4MV+UtgzU2HO9713LjpQLSfrw4GMOlyxaLuXj4v6a3A0J5diPavfQdjpk36W7RrQ3cL++zXeLoxzUvtt6rtLPvVL3BIjVDb41lGv5g1GJ5ZnO+O68vL/3Au28HNmIp6ookvs6kgonJdryWg4Sis1fYipeDIMAsjr4rapsozg6GsvmGG9VMTeqiin/I6U3wnlcjxQQ5L9y8RpZHh6KGmm5XNEXr3ZylCauLJcWLJfL/wF345aZ sidebar_class_name: "get api-method" info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api custom_edit_url: null @@ -744,8 +744,8 @@ Fetches a list of receivers within a specific disbursement using the disbursemen name={"status"} required={false} schemaName={"PaymentStatus (string)"} - qualifierMessage={"**Possible values:** [`DRAFT`, `READY`, `PENDING`, `PAUSED`, `SUCCESS`, `FAILED`]"} - schema={{"type":"string","description":"The status of the payment","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"],"title":"PaymentStatus"}} + qualifierMessage={"**Possible values:** [`DRAFT`, `READY`, `PENDING`, `PAUSED`, `SUCCESS`, `FAILED`, `CANCELED`]"} + schema={{"type":"string","description":"The status of the payment","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED","CANCELED"],"title":"PaymentStatus"}} > +     +     + + + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + + + + + +     +     + + +
    + + + Schema + +
    + +
      + any +
    +
    +     + @@ -1564,7 +1702,7 @@ Fetches a list of receivers within a specific disbursement using the disbursemen value={"Example"} > diff --git a/platforms/stellar-disbursement-platform/api-reference/list-all-payments.api.mdx b/platforms/stellar-disbursement-platform/api-reference/list-all-payments.api.mdx index 67e7e67dc..85e8131b8 100644 --- a/platforms/stellar-disbursement-platform/api-reference/list-all-payments.api.mdx +++ b/platforms/stellar-disbursement-platform/api-reference/list-all-payments.api.mdx @@ -5,7 +5,7 @@ description: "Returns all individual payments matching the request criteria. Thi sidebar_label: "List All Payments" hide_title: true hide_table_of_contents: true -api: eJztWm1v2zgS/iuEPhy2gGXr3S/A4uDGTpo2SdM4abbtBgEljmxuJEpLUkl9gf/7gZRky4ljp2kK7AH3pY2leXlmOJwZjnhvSDwVxuCbcYrnKTApjKuWQUBEnOaSZswYGGcgC84EwkmCKCP0lpICJyivGFCKZTSjbIrkDBCHvwsQEkWcSuAUt9H5jAoEjOQZZRKJIs8zLgXK8ZQyrFQgzAiKaaLo2RRlrBaNhMSyEC3EIQJ6CxwdjlqaWtIUhMRp3kZjHM2WDDMsEAGJaSKUHAVIcswEjrQiKgUk8UpeCxEqwoILUNwthIUA2arUohkVMuPzUmOYZNFNNMOUIcrijKcaettoGVkOXP84JMbAOKJCDpNk6c2WkWOOU5DAlZvvDYZTMAZGjqdgtAyqHPx3AXxuPHT7+QyUk5YuBaK0qR+UAzEGMU4EtAwh54kSqDAZLQO+50lGwBhIXqi30QxSbAzuDTnPFRkr0hC4VhbjIpHGwF4sWmuwrhOaUrkd3AhiygDNsjuUYjZHHESRSIHuaJKgUGFWMQMEUVaFhcgzJuDXmOBYTRvK5duOf/wdR7KM3DpQqlXPYv2riqjXwCukimtFyIpUbbXR2XD/3GgZZ+Ph6IvRMk7HJ6PDkwP11/BiMh4ZLWNysbc3nkyMlrE/PDwaj4yrhVKE01xrLiU0bK4j+pqS7YZfXByOkJxhiTjkHITewXi1w6r1IljiEAt4PfPX8IdBGARdTMwgihzTC6LY7IfQNf3AJhhH0CVer2lexAFLINdYXuNY6sXfYuNHlsyrCFxlKW0z5oAqWUgLQlJlJ4IltNG+3tUD9OXLly/m8bE5Gv0i6x3LCkzLNi3nCRtDiDO+Iz08z8hS0j/ISpHxHalln0JCUCGAIJkhRb+07zU34zJ5NBzf2KONh1fN5EIoB11MduTHmgzFGddGqNJW2/GqWWVlCBZRw4Lyl4KlLLhSGsscLJQUx7LUf+uoh3VVBoISKqRKhg3fRxmTwKTiw3me0EiXvc5fQjHfP4aYhX9BpJyac1UkJS1Vryr/bloG3+XGVLoMs3+rkvW7+69V5fpdBZyRc7h9Dqf9mBNPS+UVK2USpjrnLHl7i5YhM4mT7WR2sFCEVGp9pyu7Fy1DZdgGN+YcqzCiElKx2y+UbLeNkNhxYt83Xcfvm17PcUzsgWNGYNmu6/X73dhTKHCaFWyjhx83IyXtgwK5ptW2rLZlKblCQpJgft3ovq43Y36s53BU61jr3crCNCkFIwbyLuM3bXQoUYSZ6jnKlEEzxRbdNEE+wYwKoXblt/rxEQ4zjlXPd/XbTMpcDDqdZPmsXdnUzvi086aFMr7kHH9XS7NiqilBP++8aa95yQpdt0/sqNcnru3ZvSDs2V43cnDsRX3cB+KHIQkj0sUE94jt9gLX7VvdwOuHyrUR5VECpWdj4NdVe/hs9+5pflTzLzv2w5F2JlWdczJHVXOA7mbA1nx5h1XLT6DyXilu3cKuh4NeGGDTjYOu6TleaIa90DLB77vY7pOuF7jNKFm20BuN0IS6pXuWfRv7uJ/tvpq7WAuclIiW2K6r08KGLf0gxzKEp1MO07Usm4LEKiOgcr8LpHItpqw+VpVKQJSnH7U16hOQ4q7XSCytj2aYTUGgLIoKzsujwzNTy/+Ar1MQQp2fNoXK0jGbLCgPbio/YgmmIjXWWxbHNS3HtNxz2xp4/sC3vxrrKbwB6F254mMm+dzYQaQzfuOs+dIM/3gJCkb/LgBRAkzSmAKvV2NNXcP0otBnhJXVkW+H2Ca+6TvENT3biU3s9yMzgNh1iN/Hoad3a9kBPQeTonwCRqNENV6YfxUMTKe/fa8/FVWT8+HZuQ6mZVTtfTw+PRqfr4fTqKFxFVONTu9Zxml6VZHWtuA2j28LtsB0rXPLHjjOwO+2e67d7/pfFawiJz8EK8FCopLp9ZH12q4d+PaD3dD05xGVoBsKNUL5+f4ljjFEXuiaXhBapkdCz8Re5JlB5PpWz/K7XcvXi6db5F3+GSpQSNM2lVxMRntKCBWiAP5cMSU1woRwEGJN4MHbtyOve7gfHF1+6J52j0fjz5O9y7Pu6PTi8rN78sUdnX8af94/8k6G597w0zv369HR/tHQ3x2GL0pcu4LohUIJJPCTQoNKqL9KsY8jum7LdEihZSDV0adXQ+FZzj7ucJK8RvD1LNdybeKZNrE80+t1+2YYkL5JIj/w7Ljf7/WgqfjnNVpOHxwglhlDGJhe5FlmL/S6ptVzA9zzu56NnbWtd1aprrfda5nuY6I7UNPzfWx63Z5jYgvAtAOrG3TBIhDa22rBStJnGnLMJBoKQYVep1mWQr6xbDf56h76tuTHed6OsnTN+EttbG163UTWG3Kr9IO9P4bv3T/eu58/uO/337mfjkf7Hycfjp2T4+Ovbycf3c+H58H44vTT5WR06bzveseOe3Y2Odq9Q7fum7ZlWc/YkM+T8eMF8mx8cDg5H5/p0rh/NDw4WC+MdTSJ0rN1bdwQb+uu/1/JWY+bM2Ox4WHzgK7fe5b9eEhywXAhZxmn/wHyekMR4DzbUIL0RE1y/JK+vZqTL1rG0/2yNnPpviUM4ySTaM3MFYpaj2fZDckPOX6l4HJp3MdLs5/xkBIC7Nevy2brVgCeQaDtEBAVnMq5/jb0FjAHPizkzBh8u1IzuxTkLFPflaagsWH1yug0hnIC+G39bangiTEwDMVYy50oO0tTmtJXh9ScfoDHp9T3l+flPEWNL5X31emidGELCTpVn3buqJwhzNB44vgByjm9Vb3nDczVYbMalw6rhcPNkekMMFGBqVovFmcaTbUT65rfbC3RaYKl2vdoeHpotAxlbonSadttS/mgSFOszt5rfcNmGb9NRqdv1JQDI5llCQoLmkhtZsanmFVQhZo9p/gGUFgkN40Be4YwmvKs0K01h4jmVL/IbvXHhMcDqo3N+j8L4p/sT6a/0iqVDGU5MFNkBY8A5TxT26L8sEBFBUUdfrLl4eKBuNZyRqEa7no4F2cFI/WntjhLkuxOzTY45JmgMuMUxEDhMNG3qqDXUzRz7aCYV04yQxzdACOroduUylkRqmah80MS3gzKT9RLKPN6+CI02IpMW0VZzLGQvIhkwSsD1brIXWva/gHLYq5T18+YVovYZdsdhKimfbE1M0hSM5phLsVWyA26juQAnRRT1qkebLVnlxnvIEmRFqTxE8iTbF6PzrbvtXKIeVOEwBlIEO0/VZqSwFPxMZ4Av6VRsyttzoA1kZnFpqjIWkZCI2BCZ/w6AeY4mgFydJ4q87OSNeh07u7u2li/1dIqVtE5Otwbn0zGptO22jOZJjpP5pmQKWYNweqiARomCWpcNVhLNPerEvj/Kxzbr3BUtVDCd9nJE0z1Bxq9WPdVyf1m5I37MbNMSPXs/l59I7/gyWKhHpefAlUhJlTgMGl83HtyZTbf8tgI6Abmq4sjtzgpQBf71o+o+5l7GztALa+NvBDaj1zJ2AJlefvjhTB+/ILEFjDr1zJeiOg1rzNswbrhjsUvBfzMqwnPQ7y8MfFCyNsvHWwLt/I+w0u3485rAltUN68irPRfqR+cKgD6ENGq222Vl0rGYRRB3kT96IC0dvQ4GKtZAn50brjR54bqDyW9fsXmDdkPTwAlBPWvctVGlvv78lSyWCzpy1dPclQm1tTKS1eLxeK/yE/j6Q== +api: eJztWm1v2zgS/iuEPhy2gGTrzfILsDi4sZOmTdI0Tpptu0FAiSObG4nSklRSX+D/fiAl2XLi2GmaAnvAfWljaV6eGQ5nhiPeGxJPhTH4ZpzieQpMCuPKNAiIiNNc0owZA+MMZMGZQDhJEGWE3lJS4ATlFQNKsYxmlE2RnAHi8HcBQqKIUwmc4hY6n1GBgJE8o0wiUeR5xqVAOZ5ShpUKhBlBMU0UPZuijNWikZBYFsJEHCKgt8DR4cjU1JKmICRO8xYa42i2ZJhhgQhITBOh5ChAkmMmcKQVUSkgiVfyTESoCAsuQHGbCAsB0qzUohkVMuPzUmOYZNFNNMOUIcrijKcaesswjSwHrn8cEmNgHFEhh0my9KZp5JjjFCRw5eZ7g+EUjIGR4ykYpkGVg/8ugM+Nh24/n4Fy0tKlQJQ29YNyIMYgxokA0xByniiBCpNhGvA9TzICxkDyQr2NZpBiY3BvyHmuyFiRhsC1shgXiTQGzmJhrsG6TmhK5XZwI4gpAzTL7lCK2RxxEEUiBbqjSYJChVnFDBBEWRUWIs+YgF9jgms3bSiXbzv+8XccyTJy60CpVj2L9a8qol4Dr5AqrhUhK1K11UZnw/1zwzTOxsPRF8M0Tscno8OTA/XX8GIyHhmmMbnY2xtPJoZp7A8Pj8Yj42qhFOE015pLCQ2b64i+pmS74RcXhyMkZ1giDjkHoXcwXu2war0IljjEAl7P/DX8YRAGQRcTK4gi1/KDKLb6IXStTuAQjCPoEr/XNC/igCWQayyvcSz14m+x8SNL5lUErrKUthlzQJUspAUhqbITwRJaaF/v6gH68uXLF+v42BqNfpH1rm0Hlu1YtvuEjSHEGd+RHp5nZCnpH2SlyPiO1LJPISGoEECQzJCiX9r3mptxmTwajm/s0cbDq2ZyIZSDLiY78mNNhuKMayNUaavteNWssjIEi6hhQflLwVIWXCmNZQ4WSopr2+q/ddTDuioDQQkVUiXDhu+jjElgUvHhPE9opMte+y+hmO8fQ8zCvyBSTs25KpKSlqpXlX83LYPvcmMqXYbZv1XJ+t3716py/a4Czsg53D6H03nMiael8oqVMglTnXOWvL2FachM4mQ7mRMsFCGVWt/pyu6FaagM2+DGnGMVRlRCKnb7hZLtthESu27c6Vie2+lbfs91LeyDa0VgO57n9/vd2FcocJoVbKOHHzcjJe2DArmm1bHtlm0ruUJCkmB+3ei+rjdjfqzncFTrWOvdysI0KQUjBvIu4zctdChRhJnqOcqUQTPFFt00QT7BjAqhduW3+vERDjOOVc939dtMylwM2u1k+axV2dTK+LT9xkQZX3KOv6ulWTHVlKCft9+01rxkh57XJ07U6xPP8Z1eEPYcvxu5OPajPu4D6YQhCSPSxQT3iOP1As/r293A74fKtRHlUQKlZ2Pg11V7+Gz37ml+VPMvO/bDkXYmVZ1zMkdVc4DuZsDWfHmHVctPoPJeKW7dwq6Pg14YYMuLg67lu35ohb3QtqDT97DTJ10/8JpRsmyhNxqhCXVL9yz7NvZxP9l9mcbe8GRvrBux5obWsicluCXM6+rgsGF3P0i3DOHplMN0LeGmILFKDqjc+gKptIspq09YpRIQ5UFI7ZL6MKS46+USS0dEM8ymIFAWRQXn5SnimVnmf8vtKQihTlWbAmjpo03GlMc5lTWxBEuRGuuNjOtZtmvZ3rljD/zOoON8NdYTewPQu3Lxx0zyubGDSNeBxgn0pXn/8WoUjP5dAKIEmKQxBV4vzJq6hulFoU8OK6ujjhNih3Ssjks8y3fc2MKdfmQFEHsu6fRx6Os9XPZFz8GkKJ+A0ShcjRfWXwUDy+1vzwBPBdjkfHh2roNoGWB7H49Pj8bn6+E0amhcxVSj/3uWcZpe1am13bjN49uCLbA8+9x2Bq476HRbPc/pdztfFawiJz8EK8FCopLp9ZH1Wp4TdJwHu6HpzyMqQbcZarDy811NHGOI/NCz/CC0LZ+EvoX9yLeCyOvYPbvT7dodvXi6cd7ln6EChTRtU8nFZLSnhFAhCuDPFVNSI0wIByHWBB68fTvyu4f7wdHlh+5p93g0/jzZuzzrjk4vLj97J1+80fmn8ef9I/9keO4PP73zvh4d7R8NO7vD8EWJa1cQvVAogQR+UmhQCe2sUuzjiK6bNR1SaBlIdfTp1VB4lhORO5wkrxF8PduzPYf4lkNs3/J73b4VBqRvkagT+E7c7/d60FT88xpttw8uENuKIQwsP/Jtqxf6XcvueQHudbq+g921rXdWqa633WuZ3sFE96WW3+lgy+/2XAvbAJYT2N2gCzaB0NlWC1aSPtOQYybRUAgq9DrNshTyjWW7yVd31rclP87zVpSla8ZfamNr0+vWst6QW6Uf7P0xfO/98d77/MF7v//O+3Q82v84+XDsnhwff307+eh9PjwPxhenny4no0v3fdc/dr2zs8nR7h26dd+0bNt+xoZ8nowfL5Bn44PDyfn4TJfG/aPhwcF6YayjSZSerWvjhnhbd/3/Ss563JwZiw0Pm8d2/d63ncejkwuGCznLOP0PkNcblQDn2YYSpOdskuOXtPDV9HxhGk/3y9rMpfuWMIyTTKI1M1coaj2+7TQkP+T4lYLLpfEeL81+xkNKCLBfvy6brVsBeAaBtkNAVHAq5/qL0VvAHPiwkDNj8O1KTfJSkLNMfW2agsaG1Suj3RjVCeC39RengifGwDAUYy13ouwsTWlKX51Xc/oBHh9Y31+el1MWNdRU3leni9KFJhJ0qj743FE5Q5ih8cTtBCjn9Fb1njcwV+fOaog6rBYONwepM8BEBaZqvVicaTTVTqxrfrO1RKcJlmrfo+HpoWEaytwSpdtyWrbyQZGmWB3D1/qGzTJ+m4xO36jZB0YyyxIUFjSR2syMTzGroAo1kU7xDaCwSG4aY/cMYTTlWaFbaw4Rzal+kd3qTwyPx1Ybm/V/FsQ/2Z9Mf7tVKhnKcmCWyAoeAcp5prZF+bmBigqKOvxky8PFA3HmclyhGu56ZBdnBSP1B7g4S5LsTo05OOSZoDLjFMRA4bDQt6qg17M1a+2gmFdOskIc3QAjq1HclMpZEapmof1DEt4Myg/XSyjzeg4jNNiKTFtFWcyxkLyIZMErA9W6yF1r2voBy2KuU9fPmFaL2GXbHYSopn2xNTNIUiuaYS7FVsgNurbkAO0UU9auHmy1Z5cZ7yBJkRak8RPIk2xeT9G277VytHlThMAZSBCtP1WaksBT8TGeAL+lUbMrbU6GNZGVxZaoyEwjoREwoTN+nQBzHM0AuTpPlflZyRq023d3dy2s32ppFatoHx3ujU8mY8tt2a2ZTBOdJ/NMyBSzhmB1/QANkwQ1LiCsJZr7VQn8/8WO7Rc7qloo4bts5wmm+rONXqz7quR+M/LGrZlZJqR6dn+vvpxf8GSxUI/LD4SqEBMqcJg0Pvk9uTKb735sBHQD89V1klucFKCLvfkj6n7mNscOUMvLJC+E9iMXNbZAWd4JeSGMH782sQXM+mWNFyJ6zUsOW7BuuHnxSwE/88LC8xAv71G8EPL2qwjbwq285fDS7bjz8sAW1c0LCiv9V+oHpwqAPkSYdbut8lLJOIwiyJuoHx2Q1o4eB2M1S8CPzg03+txQ/aGk16/YvCH74QmghKD+Va7ayHJ/X55KFoslffnqSY7KxJpaeelqsVj8F+mX6Sc= sidebar_class_name: "get api-method" info_path: platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api custom_edit_url: null @@ -315,8 +315,8 @@ Returns all individual payments matching the request criteria. This endpoint sup name={"status"} required={false} schemaName={"PaymentStatus (string)"} - qualifierMessage={"**Possible values:** [`DRAFT`, `READY`, `PENDING`, `PAUSED`, `SUCCESS`, `FAILED`]"} - schema={{"type":"string","description":"The status of the payment","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"],"title":"PaymentStatus"}} + qualifierMessage={"**Possible values:** [`DRAFT`, `READY`, `PENDING`, `PAUSED`, `SUCCESS`, `FAILED`, `CANCELED`]"} + schema={{"type":"string","description":"The status of the payment","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED","CANCELED"],"title":"PaymentStatus"}} > Date: Fri, 17 Jan 2025 15:47:11 -0800 Subject: [PATCH 4/5] Update testing guide structure and add coverage testing (#1182) --- docs/build/guides/testing/code-coverage.mdx | 53 +++++++++++++++++++ .../build/guides/testing/coverage-testing.mdx | 9 ---- ...differential-tests-with-test-snapshots.mdx | 2 +- .../guides/testing/differential-tests.mdx | 2 +- docs/build/guides/testing/fuzzing.mdx | 2 +- .../integration-tests-with-mainnet-data.mdx | 3 +- .../guides/testing/integration-tests.mdx | 2 +- .../build/guides/testing/mutation-testing.mdx | 4 +- .../guides/testing/test-contract-auth.mdx | 1 + .../guides/testing/test-contract-events.mdx | 1 + 10 files changed, 63 insertions(+), 16 deletions(-) create mode 100644 docs/build/guides/testing/code-coverage.mdx delete mode 100644 docs/build/guides/testing/coverage-testing.mdx diff --git a/docs/build/guides/testing/code-coverage.mdx b/docs/build/guides/testing/code-coverage.mdx new file mode 100644 index 000000000..8a5def0c1 --- /dev/null +++ b/docs/build/guides/testing/code-coverage.mdx @@ -0,0 +1,53 @@ +--- +title: Code Coverage +hide_table_of_contents: true +description: Code coverage tools find code not tested. +sidebar_position: 10 +--- + +Measuring code coverage uses tools to identify lines of code that are and aren't executed by tests. Code coverage stats can give us an idea of how much of a contract is actually tested by its tests. + +:::tip + +Mutation testing is another form of coverage testing. See [Mutation Testing]. + +::: + +In rust projects the `cargo-llvm-cov` tool can be used to generate coverage stats, HTML reports, and lcov files that IDEs will load to display the coverage in the code editor. + +Install `cargo-llvm-cov` before proceeding with the other commands. + +``` +cargo install cargo-llvm-cov +``` + +## How to Get Coverage Stats + +Run the test subcommand that will run the tests and output the stats per file. + +``` +cargo llvm-cov test +``` + +## How to Generate a Coverage Report with Code + +Run the test subcommand that will run the tests and output a set of HTML files showing which lines of code are covered. + +``` +cargo llvm-cov test --html --open +``` + +The output of the command will indicate where the HTML file has been written. Open the file in a browser. + +## How to Generate an LCOV File for IDEs + +Run the test subcommand that will run the tests and output a single `lcov.info` file. + +``` +cargo llvm-cov test --lcov --output-path=lcov.info +``` + +Load the `lcov.info` file into your IDE using it's coverage feature. In VSCode this can be done by installing the [Coverage Gutters] extension and executing the `Coverage Gutters: Watch` command. + +[Coverage Gutters]: https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters +[Mutation Testing]: mutation-testing.mdx diff --git a/docs/build/guides/testing/coverage-testing.mdx b/docs/build/guides/testing/coverage-testing.mdx deleted file mode 100644 index 0979d2849..000000000 --- a/docs/build/guides/testing/coverage-testing.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Coverage Testing -hide_table_of_contents: true -description: Coverage testing finds code not tested. -sidebar_position: 10 -draft: true ---- - -**TODO: Fill in example.** diff --git a/docs/build/guides/testing/differential-tests-with-test-snapshots.mdx b/docs/build/guides/testing/differential-tests-with-test-snapshots.mdx index 30b649ceb..61aad39bb 100644 --- a/docs/build/guides/testing/differential-tests-with-test-snapshots.mdx +++ b/docs/build/guides/testing/differential-tests-with-test-snapshots.mdx @@ -2,7 +2,7 @@ title: Differential Tests with Test Snapshots hide_table_of_contents: true description: Differential testing using automatic test snapshots. -sidebar_position: 8 +sidebar_position: 9 --- Tests are written to ensure that contracts behave today as expected, and in the future as well. Over time a contract may change and in all software development there remains the possibility of changes causing side-effects that are unexpected. Testing is one of the ways that we identify unexpected changes. diff --git a/docs/build/guides/testing/differential-tests.mdx b/docs/build/guides/testing/differential-tests.mdx index e9036b2f3..9a5674f8f 100644 --- a/docs/build/guides/testing/differential-tests.mdx +++ b/docs/build/guides/testing/differential-tests.mdx @@ -2,7 +2,7 @@ title: Differential Tests hide_table_of_contents: true description: Differential testing detects unintended changes. -sidebar_position: 7 +sidebar_position: 8 --- Differential testing is the testing of two things to discover differences in their behavior. diff --git a/docs/build/guides/testing/fuzzing.mdx b/docs/build/guides/testing/fuzzing.mdx index 6b588c996..396422b82 100644 --- a/docs/build/guides/testing/fuzzing.mdx +++ b/docs/build/guides/testing/fuzzing.mdx @@ -2,7 +2,7 @@ title: Fuzzing hide_table_of_contents: true description: Fuzzing and property testing to find unexpected behavior. -sidebar_position: 5 +sidebar_position: 7 --- Fuzzing is the process of providing random data to programs to identify unexpected behavior, such as crashes and panics. diff --git a/docs/build/guides/testing/integration-tests-with-mainnet-data.mdx b/docs/build/guides/testing/integration-tests-with-mainnet-data.mdx index a8fa9ecd3..04fb6f4e6 100644 --- a/docs/build/guides/testing/integration-tests-with-mainnet-data.mdx +++ b/docs/build/guides/testing/integration-tests-with-mainnet-data.mdx @@ -2,8 +2,7 @@ title: Integration Tests with Mainnet Data hide_table_of_contents: true description: Integration testing uses dependency contracts instead of mocks. -sidebar_position: 4 -draft: true +sidebar_position: 6 --- Testing with mainnet data is another form of [integration test], where not only mainnet contracts can be used, but also their data on mainnet. diff --git a/docs/build/guides/testing/integration-tests.mdx b/docs/build/guides/testing/integration-tests.mdx index 06003d7eb..b11d5defa 100644 --- a/docs/build/guides/testing/integration-tests.mdx +++ b/docs/build/guides/testing/integration-tests.mdx @@ -2,7 +2,7 @@ title: Integration Tests hide_table_of_contents: true description: Integration testing uses dependency contracts instead of mocks. -sidebar_position: 3 +sidebar_position: 5 --- Integration tests are tests that include the integration between components, and so test a larger scope such as other contracts. diff --git a/docs/build/guides/testing/mutation-testing.mdx b/docs/build/guides/testing/mutation-testing.mdx index 8bccad902..f731e1c0f 100644 --- a/docs/build/guides/testing/mutation-testing.mdx +++ b/docs/build/guides/testing/mutation-testing.mdx @@ -2,7 +2,7 @@ title: Mutation Testing hide_table_of_contents: true description: Mutation testing finds code not tested. -sidebar_position: 9 +sidebar_position: 11 --- Mutation testing is making changes to a program, either manually or automatically, to identify changes that can be made that don't get caught by tests. @@ -33,3 +33,5 @@ The `cargo-mutants` tool can be used to automatically and iteratively modify the Code that is identified as not covered by a test will be outputted as a `MISSED` line in the output. Diffs of each change that was attempted can be found in the `mutants.out/diff` directory. + +[code coverage]: code-coverage.mdx diff --git a/docs/build/guides/testing/test-contract-auth.mdx b/docs/build/guides/testing/test-contract-auth.mdx index 3cac5898c..054deb1b6 100644 --- a/docs/build/guides/testing/test-contract-auth.mdx +++ b/docs/build/guides/testing/test-contract-auth.mdx @@ -2,6 +2,7 @@ title: Test Authorization hide_table_of_contents: true description: Write tests that test contract authorization. +sidebar_position: 3 --- Tests can assert on the auths that are expected to occur. diff --git a/docs/build/guides/testing/test-contract-events.mdx b/docs/build/guides/testing/test-contract-events.mdx index 07f28562d..9360d1592 100644 --- a/docs/build/guides/testing/test-contract-events.mdx +++ b/docs/build/guides/testing/test-contract-events.mdx @@ -2,6 +2,7 @@ title: Test Events hide_table_of_contents: true description: Write tests that test contract events. +sidebar_position: 4 --- Tests can assert on events that are expected to be published. From f6d5d7b1594c6441b4505a925caecca560c49d5c Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Sat, 18 Jan 2025 21:44:44 -0800 Subject: [PATCH 5/5] fix fuzzing example (#1184) --- docs/build/guides/testing/fuzzing.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/guides/testing/fuzzing.mdx b/docs/build/guides/testing/fuzzing.mdx index 396422b82..de2014622 100644 --- a/docs/build/guides/testing/fuzzing.mdx +++ b/docs/build/guides/testing/fuzzing.mdx @@ -59,7 +59,7 @@ The following steps can be used in any Stellar contract workspace. If experiment use libfuzzer_sys::fuzz_target; use soroban_increment_with_fuzz_contract::{IncrementContract, IncrementContractClient}; use soroban_sdk::{ - testutils::arbitrary::{self, Arbitrary}, + testutils::arbitrary::{arbitrary, Arbitrary}, Env, };