From a05787625d93043e73abcd4e0c60671790a5104b Mon Sep 17 00:00:00 2001 From: Jake Urban Date: Mon, 31 Jul 2023 09:24:02 -0700 Subject: [PATCH] update Wallet-Registration tag to Registration to match resource in docs --- api/anchor-platform/callbacks/get-rates.api.mdx | 2 +- .../resources/get-transaction.api.mdx | 2 +- .../resources/get-transactions.api.mdx | 2 +- .../resources/patch-transactions.api.mdx | 4 ++-- .../resources/create-disbursements.api.mdx | 2 +- ...-assets-supported-by-this-organization.api.mdx | 2 +- ...untries-supported-by-this-organization.api.mdx | 2 +- ...wallets-supported-by-this-organization.api.mdx | 2 +- .../list-all-disbursement-receivers.api.mdx | 2 +- .../resources/list-all-disbursements.api.mdx | 2 +- .../resources/list-all-payments.api.mdx | 2 +- .../resources/list-all-receivers.api.mdx | 2 +- .../load-the-pii-confirmation-webpage.api.mdx | 4 ++-- .../resources/retrieve-a-disbursement.api.mdx | 2 +- .../resources/retrieve-a-payment.api.mdx | 2 +- .../resources/retrieve-a-receiver.api.mdx | 2 +- .../resources/send-otp.api.mdx | 4 ++-- .../resources/sidebar.js | 2 +- .../resources/update-the-receiver.api.mdx | 2 +- .../verify-receiver-registration.api.mdx | 4 ++-- openapi/stellar-disbursement-platform/bundled.yml | 12 ++++++------ openapi/stellar-disbursement-platform/main.yml | 15 +++++++-------- 22 files changed, 37 insertions(+), 38 deletions(-) diff --git a/api/anchor-platform/callbacks/get-rates.api.mdx b/api/anchor-platform/callbacks/get-rates.api.mdx index 32eb9193a..e3e80a9b6 100644 --- a/api/anchor-platform/callbacks/get-rates.api.mdx +++ b/api/anchor-platform/callbacks/get-rates.api.mdx @@ -52,7 +52,7 @@ Success. An object describing the fees added on top of the rate provided via the `price` attribute. -
details object[]
  • Array [
  • ]
    • +
    details object[]
  • Array [
  • ]
    • Unprocessable Entity. This status should be returned when the anchor understood the request but cannot return a success response. diff --git a/api/anchor-platform/resources/get-transaction.api.mdx b/api/anchor-platform/resources/get-transaction.api.mdx index 0f16bed5e..247417f00 100644 --- a/api/anchor-platform/resources/get-transaction.api.mdx +++ b/api/anchor-platform/resources/get-transaction.api.mdx @@ -67,7 +67,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
    +
    Bad Request diff --git a/api/anchor-platform/resources/get-transactions.api.mdx b/api/anchor-platform/resources/get-transactions.api.mdx index f4b047cc5..7da0d9a81 100644 --- a/api/anchor-platform/resources/get-transactions.api.mdx +++ b/api/anchor-platform/resources/get-transactions.api.mdx @@ -67,7 +67,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
  • ]
    • +
  • ]
    • Bad Request diff --git a/api/anchor-platform/resources/patch-transactions.api.mdx b/api/anchor-platform/resources/patch-transactions.api.mdx index 5d367cb21..f9a4ea14b 100644 --- a/api/anchor-platform/resources/patch-transactions.api.mdx +++ b/api/anchor-platform/resources/patch-transactions.api.mdx @@ -5,7 +5,7 @@ description: "Accepts one or more objects containing updated information on tran sidebar_label: "Update Transactions Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"patchTransactions","description":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","responses":{"200":{"description":"Transaction(s) updated.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"}}},"title":"TransactionListSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}}},"title":"TransactionListSEP31"}]}}}},"400":{"description":"Invalid request body. The error returned pertains to the transaction first determined to be invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string","description":"The `id` of the transaction first determined to be invalid."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP24"}}}}},"title":"PatchTransactionSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"message":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP31"}}}}},"title":"PatchTransactionSEP31"}]}}}},"method":"patch","path":"/transactions","jsonRequestBodyExample":{"records":[{"transaction":{"id":"string","sep":"24","status":"incomplete","amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-07-31T16:05:22.516Z","updated_at":"2023-07-31T16:05:22.516Z","completed_at":"2023-07-31T16:05:22.516Z","transfer_received_at":"2023-07-31T16:05:22.516Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-07-31T16:05:22.516Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"memo":"string","memo_type":"text id hash","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2023-07-31T16:05:22.516Z","refunded_at":"2023-07-31T16:05:22.516Z"}]}}}]},"info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Update Transactions Info","description":{"content":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"patchTransactions","description":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","responses":{"200":{"description":"Transaction(s) updated.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"}}},"title":"TransactionListSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}}},"title":"TransactionListSEP31"}]}}}},"400":{"description":"Invalid request body. The error returned pertains to the transaction first determined to be invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string","description":"The `id` of the transaction first determined to be invalid."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP24"}}}}},"title":"PatchTransactionSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"external_transaction_id":{"type":"string"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"message":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"}},"title":"MutableTransactionSEP31"}}}}},"title":"PatchTransactionSEP31"}]}}}},"method":"patch","path":"/transactions","jsonRequestBodyExample":{"records":[{"transaction":{"id":"string","sep":"24","status":"incomplete","amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-07-31T16:14:00.368Z","updated_at":"2023-07-31T16:14:00.368Z","completed_at":"2023-07-31T16:14:00.368Z","transfer_received_at":"2023-07-31T16:14:00.368Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-07-31T16:14:00.368Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"memo":"string","memo_type":"text id hash","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2023-07-31T16:14:00.368Z","refunded_at":"2023-07-31T16:14:00.368Z"}]}}}]},"info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Update Transactions Info","description":{"content":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: api/anchor-platform/resources/platform-api custom_edit_url: null @@ -100,7 +100,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
  • ]
    • +
  • ]
    • Invalid request body. The error returned pertains to the transaction first determined to be invalid. diff --git a/api/stellar-disbursement-platform/resources/create-disbursements.api.mdx b/api/stellar-disbursement-platform/resources/create-disbursements.api.mdx index e49f65489..6c7314215 100644 --- a/api/stellar-disbursement-platform/resources/create-disbursements.api.mdx +++ b/api/stellar-disbursement-platform/resources/create-disbursements.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; A new disbursement -
    Schema
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
    +
    Schema
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
    Bad Request diff --git a/api/stellar-disbursement-platform/resources/get-a-list-of-assets-supported-by-this-organization.api.mdx b/api/stellar-disbursement-platform/resources/get-a-list-of-assets-supported-by-this-organization.api.mdx index 660765bfa..74e766894 100644 --- a/api/stellar-disbursement-platform/resources/get-a-list-of-assets-supported-by-this-organization.api.mdx +++ b/api/stellar-disbursement-platform/resources/get-a-list-of-assets-supported-by-this-organization.api.mdx @@ -34,7 +34,7 @@ Get a list of assets supported by this organization A list of assets -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/get-a-list-of-countries-supported-by-this-organization.api.mdx b/api/stellar-disbursement-platform/resources/get-a-list-of-countries-supported-by-this-organization.api.mdx index 30eb2de91..88586fbc8 100644 --- a/api/stellar-disbursement-platform/resources/get-a-list-of-countries-supported-by-this-organization.api.mdx +++ b/api/stellar-disbursement-platform/resources/get-a-list-of-countries-supported-by-this-organization.api.mdx @@ -34,7 +34,7 @@ Get a list of countries supported by this organization A list of countries -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/get-a-list-of-wallets-supported-by-this-organization.api.mdx b/api/stellar-disbursement-platform/resources/get-a-list-of-wallets-supported-by-this-organization.api.mdx index e35142034..dc8d739e2 100644 --- a/api/stellar-disbursement-platform/resources/get-a-list-of-wallets-supported-by-this-organization.api.mdx +++ b/api/stellar-disbursement-platform/resources/get-a-list-of-wallets-supported-by-this-organization.api.mdx @@ -34,7 +34,7 @@ Get a list of wallets supported by this organization A list of wallets -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx b/api/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx index da4b81a6a..4f4d380c7 100644 --- a/api/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx +++ b/api/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; A list of Disbursement Receivers -
    Schema
      pagination object
      data object[]
    • Array [
      • receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
      • payment object
      status_history object[]
    • Array [
    • ]
      • disbursement object
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
      • asset object
      receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    +
    Schema
      pagination object
      data object[]
    • Array [
      • receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
      • payment object
      status_history object[]
    • Array [
    • ]
      • disbursement object
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
      • asset object
      receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx b/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx index 75934ae8a..bdda06f5e 100644 --- a/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx +++ b/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; A list of Disbursement details -
    Schema
      pagination object
      data object[]
    • Array [
      • country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
    • ]
    +
    Schema
      pagination object
      data object[]
    • Array [
      • country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx b/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx index 73314e647..42d41dcfe 100644 --- a/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx +++ b/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; A paginated list of payments -
    Schema
      pagination object
      data object[]
    • Array [
      • status_history object[]
    • Array [
    • ]
      • disbursement object
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
      • asset object
      receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    +
    Schema
      pagination object
      data object[]
    • Array [
      • status_history object[]
    • Array [
    • ]
      • disbursement object
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
      • asset object
      receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx b/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx index 57f10c0e1..cc1b4b369 100644 --- a/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx +++ b/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; A paginated list of Receiver details -
    Schema
      pagination object
      data object[]
    • Array [
      • received_amounts object[]
    • Array [
    • ]
      • wallets object[]
    • Array [
      • receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    • ]
    +
    Schema
      pagination object
      data object[]
    • Array [
      • received_amounts object[]
    • Array [
    • ]
      • wallets object[]
    • Array [
      • receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/load-the-pii-confirmation-webpage.api.mdx b/api/stellar-disbursement-platform/resources/load-the-pii-confirmation-webpage.api.mdx index 99ba8f580..2dcd7145e 100644 --- a/api/stellar-disbursement-platform/resources/load-the-pii-confirmation-webpage.api.mdx +++ b/api/stellar-disbursement-platform/resources/load-the-pii-confirmation-webpage.api.mdx @@ -5,7 +5,7 @@ description: "This is the endpoint the browser will reach with the first token, sidebar_label: "Load the PII Confirmation Webpage" hide_title: true hide_table_of_contents: true -api: {"operationId":"Load the PII Confirmation Webpage","description":"This is the endpoint the browser will reach with the first token, so the user can confirm their PII information and then launch the wallet through a deep link. Requires a valid SEP-24 token in the request.","tags":["Wallet-Registration"],"parameters":[{"name":"token","in":"query","description":"The SEP-24 token used for authentication","required":true,"schema":{"type":"string"}},{"name":"transaction_id","in":"query","description":"The transaction id associated with the SEP-24 token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","content":{"text/html":{"schema":{"type":"string","description":"HTML page content"}}}},"400":{"description":"Bad Request","content":{"text/html":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/html":{"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":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"get","path":"/wallet-registration/start","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authorization"}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":""},"postman":{"name":"Load the PII Confirmation Webpage","description":{"content":"This is the endpoint the browser will reach with the first token, so the user can confirm their PII information and then launch the wallet through a deep link. Requires a valid SEP-24 token in the request.","type":"text/plain"},"url":{"path":["wallet-registration","start"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The SEP-24 token used for authentication","type":"text/plain"},"key":"token","value":""},{"disabled":false,"description":{"content":"(Required) The transaction id associated with the SEP-24 token","type":"text/plain"},"key":"transaction_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"text/html"}],"method":"GET"}} +api: {"operationId":"Load the PII Confirmation Webpage","description":"This is the endpoint the browser will reach with the first token, so the user can confirm their PII information and then launch the wallet through a deep link. Requires a valid SEP-24 token in the request.","tags":["Registration"],"parameters":[{"name":"token","in":"query","description":"The SEP-24 token used for authentication","required":true,"schema":{"type":"string"}},{"name":"transaction_id","in":"query","description":"The transaction id associated with the SEP-24 token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","content":{"text/html":{"schema":{"type":"string","description":"HTML page content"}}}},"400":{"description":"Bad Request","content":{"text/html":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/html":{"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":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"get","path":"/wallet-registration/start","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authorization"}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":""},"postman":{"name":"Load the PII Confirmation Webpage","description":{"content":"This is the endpoint the browser will reach with the first token, so the user can confirm their PII information and then launch the wallet through a deep link. Requires a valid SEP-24 token in the request.","type":"text/plain"},"url":{"path":["wallet-registration","start"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The SEP-24 token used for authentication","type":"text/plain"},"key":"token","value":""},{"disabled":false,"description":{"content":"(Required) The transaction id associated with the SEP-24 token","type":"text/plain"},"key":"transaction_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"text/html"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null @@ -13,7 +13,7 @@ custom_edit_url: null import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; diff --git a/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx index 5a1d82936..a5a9458d0 100644 --- a/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx +++ b/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; Disbursement details -
    Schema
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
    +
    Schema
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx index 20e7908d7..ad7c687f2 100644 --- a/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx +++ b/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; Payment details -
    Schema
      status_history object[]
    • Array [
    • ]
      • disbursement object
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
      • asset object
      receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    +
    Schema
      status_history object[]
    • Array [
    • ]
      • disbursement object
      country object
      wallet object
      asset object
      status_history object[]
    • Array [
    • ]
      • asset object
      receiver_wallet object
      receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx index 879c48bc9..84ab8c6e5 100644 --- a/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx +++ b/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; Receiver Details -
    Schema
      received_amounts object[]
    • Array [
    • ]
      • wallets object[]
    • Array [
      • receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    +
    Schema
      received_amounts object[]
    • Array [
    • ]
      • wallets object[]
    • Array [
      • receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    Unauthorized diff --git a/api/stellar-disbursement-platform/resources/send-otp.api.mdx b/api/stellar-disbursement-platform/resources/send-otp.api.mdx index 9dff42603..a6ba6fec4 100644 --- a/api/stellar-disbursement-platform/resources/send-otp.api.mdx +++ b/api/stellar-disbursement-platform/resources/send-otp.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint generates a 6-digit OTP and sends it via SMS to the sidebar_label: "Send OTP to the provided phone number" hide_title: true hide_table_of_contents: true -api: {"operationId":"SendOTP","description":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Wallet-Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number to which the OTP will be sent"}}}}},"description":"Object containing phone number","required":true},"responses":{"200":{"description":"OTP sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"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"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"429":{"description":"An OTP was sent to the given user recently and hasn't expired yet. Only after expired it will be sent to the user again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"code":{"type":"string"},"details":{"type":"string"}}}}}}}}},"method":"post","path":"/wallet-registration/otp","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authorization"}},"jsonRequestBodyExample":{"phone_number":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":""},"postman":{"name":"Send OTP to the provided phone number","description":{"content":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","otp"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"SendOTP","description":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number to which the OTP will be sent"}}}}},"description":"Object containing phone number","required":true},"responses":{"200":{"description":"OTP sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"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"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"429":{"description":"An OTP was sent to the given user recently and hasn't expired yet. Only after expired it will be sent to the user again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"code":{"type":"string"},"details":{"type":"string"}}}}}}}}},"method":"post","path":"/wallet-registration/otp","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authorization"}},"jsonRequestBodyExample":{"phone_number":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":""},"postman":{"name":"Send OTP to the provided phone number","description":{"content":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","otp"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null @@ -13,7 +13,7 @@ custom_edit_url: null import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; diff --git a/api/stellar-disbursement-platform/resources/sidebar.js b/api/stellar-disbursement-platform/resources/sidebar.js index 5802694d5..b66789336 100644 --- a/api/stellar-disbursement-platform/resources/sidebar.js +++ b/api/stellar-disbursement-platform/resources/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"stellar-disbursement-platform/resources/stellar-disbursement-platform-api"},{"type":"category","label":"Authentication","link":{"type":"generated-index","title":"Authentication","slug":"/category/stellar-disbursement-platform/resources/authentication"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/log-in","label":"Log In","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/refresh-token","label":"Refresh Token","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/authenticate-mfa","label":"Multi-factor authentication endpoint","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/forgot-password","label":"Forgot password endpoint","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/reset-password","label":"Reset password endpoint","className":"api-method post"}]},{"type":"category","label":"Disbursements","link":{"type":"generated-index","title":"Disbursements","slug":"/category/stellar-disbursement-platform/resources/disbursements"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-disbursements","label":"List All Disbursements","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/create-disbursements","label":"Create Disbursements","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-a-disbursement","label":"Retrieve a Disbursement","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-disbursement-receivers","label":"List All Disbursement Receivers","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/upload-disbursement-instructions","label":"Upload Disbursement Instructions","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/download-disbursement-instructions","label":"Download Disbursement Instructions","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/update-a-disbursement-status","label":"Update a Disbursement Status","className":"api-method patch"}]},{"type":"category","label":"Payments","link":{"type":"generated-index","title":"Payments","slug":"/category/stellar-disbursement-platform/resources/payments"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-payments","label":"List All Payments","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-a-payment","label":"Retrieve a Payment","className":"api-method get"}]},{"type":"category","label":"Receivers","link":{"type":"generated-index","title":"Receivers","slug":"/category/stellar-disbursement-platform/resources/receivers"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-receivers","label":"List All Receivers","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-a-receiver","label":"Retrieve a Receiver","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/update-the-receiver","label":"Update the Receiver","className":"api-method patch"}]},{"type":"category","label":"Statistics","link":{"type":"generated-index","title":"Statistics","slug":"/category/stellar-disbursement-platform/resources/statistics"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-all-statistics","label":"Retrieve all Statistics","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-disbursement-specific-statistics","label":"Retrieve Disbursement-specific Statistics","className":"api-method get"}]},{"type":"category","label":"Anchor","link":{"type":"generated-index","title":"Anchor","slug":"/category/stellar-disbursement-platform/resources/anchor"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/stellar-toml","label":"Stellar toml","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-sep-10-challenge-transaction","label":"GET SEP-10 Challenge Transaction","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/post-sep-10-challenge-transaction","label":"POST SEP-10 Challenge Transaction","className":"api-method post"}]},{"type":"category","label":"Wallet-Registration","link":{"type":"generated-index","title":"Wallet-Registration","slug":"/category/stellar-disbursement-platform/resources/wallet-registration"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/load-the-pii-confirmation-webpage","label":"Load the PII Confirmation Webpage","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/send-otp","label":"Send OTP to the provided phone number","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/verify-receiver-registration","label":"Verify Receiver Registration","className":"api-method post"}]},{"type":"category","label":"Profile","link":{"type":"generated-index","title":"Profile","slug":"/category/stellar-disbursement-platform/resources/profile"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/get-profile","label":"Get Profile","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-user-profile","label":"Patch User Profile","className":"api-method patch"}]},{"type":"category","label":"Users","link":{"type":"generated-index","title":"Users","slug":"/category/stellar-disbursement-platform/resources/users"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/get-all-users","label":"Get All Users","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/create-user","label":"Create User","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-user-activation","label":"Patch User Activation","className":"api-method patch"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-all-roles","label":"Get All Roles","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-user-role","label":"Patch User Role","className":"api-method patch"}]},{"type":"category","label":"Organization","link":{"type":"generated-index","title":"Organization","slug":"/category/stellar-disbursement-platform/resources/organization"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/get-organization-info","label":"Get Organization Info","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-organization-profile","label":"Patch Organization Profile","className":"api-method patch"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-organization-logo","label":"Retrieve Organization Logo","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-a-list-of-countries-supported-by-this-organization","label":"Get a list of countries supported by this organization","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-a-list-of-assets-supported-by-this-organization","label":"Get a list of assets supported by this organization","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-a-list-of-wallets-supported-by-this-organization","label":"Get a list of wallets supported by this organization","className":"api-method get"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"stellar-disbursement-platform/resources/stellar-disbursement-platform-api"},{"type":"category","label":"Authentication","link":{"type":"generated-index","title":"Authentication","slug":"/category/stellar-disbursement-platform/resources/authentication"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/log-in","label":"Log In","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/refresh-token","label":"Refresh Token","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/authenticate-mfa","label":"Multi-factor authentication endpoint","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/forgot-password","label":"Forgot password endpoint","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/reset-password","label":"Reset password endpoint","className":"api-method post"}]},{"type":"category","label":"Disbursements","link":{"type":"generated-index","title":"Disbursements","slug":"/category/stellar-disbursement-platform/resources/disbursements"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-disbursements","label":"List All Disbursements","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/create-disbursements","label":"Create Disbursements","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-a-disbursement","label":"Retrieve a Disbursement","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-disbursement-receivers","label":"List All Disbursement Receivers","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/upload-disbursement-instructions","label":"Upload Disbursement Instructions","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/download-disbursement-instructions","label":"Download Disbursement Instructions","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/update-a-disbursement-status","label":"Update a Disbursement Status","className":"api-method patch"}]},{"type":"category","label":"Payments","link":{"type":"generated-index","title":"Payments","slug":"/category/stellar-disbursement-platform/resources/payments"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-payments","label":"List All Payments","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-a-payment","label":"Retrieve a Payment","className":"api-method get"}]},{"type":"category","label":"Receivers","link":{"type":"generated-index","title":"Receivers","slug":"/category/stellar-disbursement-platform/resources/receivers"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/list-all-receivers","label":"List All Receivers","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-a-receiver","label":"Retrieve a Receiver","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/update-the-receiver","label":"Update the Receiver","className":"api-method patch"}]},{"type":"category","label":"Statistics","link":{"type":"generated-index","title":"Statistics","slug":"/category/stellar-disbursement-platform/resources/statistics"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-all-statistics","label":"Retrieve all Statistics","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-disbursement-specific-statistics","label":"Retrieve Disbursement-specific Statistics","className":"api-method get"}]},{"type":"category","label":"Anchor","link":{"type":"generated-index","title":"Anchor","slug":"/category/stellar-disbursement-platform/resources/anchor"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/stellar-toml","label":"Stellar toml","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-sep-10-challenge-transaction","label":"GET SEP-10 Challenge Transaction","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/post-sep-10-challenge-transaction","label":"POST SEP-10 Challenge Transaction","className":"api-method post"}]},{"type":"category","label":"Registration","link":{"type":"generated-index","title":"Registration","slug":"/category/stellar-disbursement-platform/resources/registration"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/load-the-pii-confirmation-webpage","label":"Load the PII Confirmation Webpage","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/send-otp","label":"Send OTP to the provided phone number","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/verify-receiver-registration","label":"Verify Receiver Registration","className":"api-method post"}]},{"type":"category","label":"Profile","link":{"type":"generated-index","title":"Profile","slug":"/category/stellar-disbursement-platform/resources/profile"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/get-profile","label":"Get Profile","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-user-profile","label":"Patch User Profile","className":"api-method patch"}]},{"type":"category","label":"Users","link":{"type":"generated-index","title":"Users","slug":"/category/stellar-disbursement-platform/resources/users"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/get-all-users","label":"Get All Users","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/create-user","label":"Create User","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-user-activation","label":"Patch User Activation","className":"api-method patch"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-all-roles","label":"Get All Roles","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-user-role","label":"Patch User Role","className":"api-method patch"}]},{"type":"category","label":"Organization","link":{"type":"generated-index","title":"Organization","slug":"/category/stellar-disbursement-platform/resources/organization"},"items":[{"type":"doc","id":"stellar-disbursement-platform/resources/get-organization-info","label":"Get Organization Info","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/patch-organization-profile","label":"Patch Organization Profile","className":"api-method patch"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-organization-logo","label":"Retrieve Organization Logo","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-a-list-of-countries-supported-by-this-organization","label":"Get a list of countries supported by this organization","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-a-list-of-assets-supported-by-this-organization","label":"Get a list of assets supported by this organization","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-a-list-of-wallets-supported-by-this-organization","label":"Get a list of wallets supported by this organization","className":"api-method get"}]}]; \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/update-the-receiver.api.mdx b/api/stellar-disbursement-platform/resources/update-the-receiver.api.mdx index 7de73e999..aa4c5d831 100644 --- a/api/stellar-disbursement-platform/resources/update-the-receiver.api.mdx +++ b/api/stellar-disbursement-platform/resources/update-the-receiver.api.mdx @@ -34,7 +34,7 @@ List of fields to patch for the receiver Updated Receiver Details -
    Schema
      received_amounts object[]
    • Array [
    • ]
      • wallets object[]
    • Array [
      • receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    +
    Schema
      received_amounts object[]
    • Array [
    • ]
      • wallets object[]
    • Array [
      • receiver object
      wallet object
      received_amounts object[]
    • Array [
    • ]
      • status_history object[]
    • Array [
    • ]
    • ]
    Bad Request diff --git a/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx b/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx index f5ed428da..bb8490ddf 100644 --- a/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx +++ b/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint verifies the receiver's registration by validating t sidebar_label: "Verify Receiver Registration" hide_title: true hide_table_of_contents: true -api: {"operationId":"VerifyReceiverRegistration","description":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Wallet-Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number used in registration"},"otp":{"type":"string","description":"One-Time Password received for verification"},"verification":{"type":"string","description":"Verification value provided by the user"},"verification_type":{"type":"string","description":"Type of verification value","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"recaptcha_token":{"type":"string","description":"Token received from Google reCAPTCHA"}}}}},"description":"Verification data including phone number, OTP, verification value, and reCAPTCHA token","required":true},"responses":{"200":{"description":"Verification successful","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"ok"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"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"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/wallet-registration/verification","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authorization"}},"jsonRequestBodyExample":{"phone_number":"string","otp":"string","verification":"string","verification_type":"DATE_OF_BIRTH","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":""},"postman":{"name":"Verify Receiver Registration","description":{"content":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"VerifyReceiverRegistration","description":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","tags":["Registration"],"parameters":[{"name":"Authorization","in":"header","description":"SEP-24 token for authorization (Format: 'Bearer {token}')","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number used in registration"},"otp":{"type":"string","description":"One-Time Password received for verification"},"verification":{"type":"string","description":"Verification value provided by the user"},"verification_type":{"type":"string","description":"Type of verification value","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"recaptcha_token":{"type":"string","description":"Token received from Google reCAPTCHA"}}}}},"description":"Verification data including phone number, OTP, verification value, and reCAPTCHA token","required":true},"responses":{"200":{"description":"Verification successful","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"ok"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"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"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/wallet-registration/verification","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authorization"}},"jsonRequestBodyExample":{"phone_number":"string","otp":"string","verification":"string","verification_type":"DATE_OF_BIRTH","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":""},"postman":{"name":"Verify Receiver Registration","description":{"content":"This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.","type":"text/plain"},"url":{"path":["wallet-registration","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null @@ -13,7 +13,7 @@ custom_edit_url: null import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; diff --git a/openapi/stellar-disbursement-platform/bundled.yml b/openapi/stellar-disbursement-platform/bundled.yml index e9a46a3c1..fc01e64da 100644 --- a/openapi/stellar-disbursement-platform/bundled.yml +++ b/openapi/stellar-disbursement-platform/bundled.yml @@ -1065,7 +1065,7 @@ paths: operationId: Load the PII Confirmation Webpage description: This is the endpoint the browser will reach with the first token, so the user can confirm their PII information and then launch the wallet through a deep link. Requires a valid SEP-24 token in the request. tags: - - Wallet-Registration + - Registration produces: - text/html parameters: @@ -1095,7 +1095,7 @@ paths: operationId: SendOTP description: This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request. tags: - - Wallet-Registration + - Registration consumes: - application/json produces: @@ -1145,7 +1145,7 @@ paths: operationId: VerifyReceiverRegistration description: This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request. tags: - - Wallet-Registration + - Registration consumes: - application/json produces: @@ -2321,9 +2321,9 @@ tags: - name: Statistics description: Endpoints related to statistics that provide general aggregated data, as well as disbursement-specific aggregated data. - name: Anchor - description: The Registration endpoints are the ones needed to register receivers with the SDP. - - name: Wallet-Registration - description: These endpoints will be used by the PII confirmation webpage during wallet registration + description: Endpoints related to authenticating a receiver wallet and initiating the registration process with the Stellar Disbursement Platform. + - name: Registration + description: These endpoints will be used by the PII confirmation webpage during wallet registration. - name: Profile description: Endpoints related to user profiles. - name: Users diff --git a/openapi/stellar-disbursement-platform/main.yml b/openapi/stellar-disbursement-platform/main.yml index 31f92fc2b..5abef3fb2 100644 --- a/openapi/stellar-disbursement-platform/main.yml +++ b/openapi/stellar-disbursement-platform/main.yml @@ -1087,7 +1087,7 @@ paths: user can confirm their PII information and then launch the wallet through a deep link. Requires a valid SEP-24 token in the request. tags: - - Wallet-Registration + - Registration produces: - text/html parameters: @@ -1120,7 +1120,7 @@ paths: phone number provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request. tags: - - Wallet-Registration + - Registration consumes: - application/json produces: @@ -1175,7 +1175,7 @@ paths: OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request. tags: - - Wallet-Registration + - Registration consumes: - application/json produces: @@ -2401,12 +2401,11 @@ tags: well as disbursement-specific aggregated data. - name: Anchor description: >- - The Registration endpoints are the ones needed to register - receivers with the SDP. - - - name: Wallet-Registration + Endpoints related to authenticating a receiver wallet and initiating the registration + process with the Stellar Disbursement Platform. + - name: Registration description: >- - These endpoints will be used by the PII confirmation webpage during wallet registration + These endpoints will be used by the PII confirmation webpage during wallet registration. - name: Profile description: Endpoints related to user profiles. - name: Users