diff --git a/api/anchor-platform/callbacks/get-rates.api.mdx b/api/anchor-platform/callbacks/get-rates.api.mdx index 45511c512..1efe467ae 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/callbacks/put-customer.api.mdx b/api/anchor-platform/callbacks/put-customer.api.mdx index 9ae269b4b..40f48cdde 100644 --- a/api/anchor-platform/callbacks/put-customer.api.mdx +++ b/api/anchor-platform/callbacks/put-customer.api.mdx @@ -5,7 +5,7 @@ description: "**The Anchor Platform does not persist any customer KYC data.**" sidebar_label: "Create or Update Customer Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-07-31","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-07-31","id_expiration_date":"2023-07-31","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-08-02","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-08-02","id_expiration_date":"2023-08-02","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null diff --git a/api/anchor-platform/resources/get-transaction.api.mdx b/api/anchor-platform/resources/get-transaction.api.mdx index ef27b40fa..ac0bd6632 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 26f3fd97c..1351db259 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 61ce8864c..047f7ccd1 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-31T22:10:29.899Z","updated_at":"2023-07-31T22:10:29.899Z","completed_at":"2023-07-31T22:10:29.899Z","transfer_received_at":"2023-07-31T22:10:29.899Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-07-31T22:10:29.899Z","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-31T22:10:29.899Z","refunded_at":"2023-07-31T22:10:29.899Z"}]}}}]},"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-08-02T00:22:23.615Z","updated_at":"2023-08-02T00:22:23.615Z","completed_at":"2023-08-02T00:22:23.615Z","transfer_received_at":"2023-08-02T00:22:23.615Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-08-02T00:22:23.615Z","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-08-02T00:22:23.615Z","refunded_at":"2023-08-02T00:22:23.615Z"}]}}}]},"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/horizon/resources/cb-retrieve-related-operations.api.mdx b/api/horizon/resources/cb-retrieve-related-operations.api.mdx index 4e67e842e..b8ee27872 100644 --- a/api/horizon/resources/cb-retrieve-related-operations.api.mdx +++ b/api/horizon/resources/cb-retrieve-related-operations.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful operations referencing a given sidebar_label: "Retrieve Related Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"CBRetrieveRelatedOperations","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"CBRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/140648659841806337"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"effects":{"href":"https://horizon.stellar.org/operations/140648659841806337/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=140648659841806337"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=140648659841806337"}},"id":"140648659841806337","paging_token":"140648659841806337","transaction_successful":true,"source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","type":"create_claimable_balance","type_i":14,"created_at":"2020-11-23T16:02:38Z","transaction_hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","sponsor":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","asset":"BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","amount":"0.1000000","claimants":[{"destination":"GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD","predicate":{"unconditional":true}}]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/claimable_balances/{claimable_balance_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"CBRetrieveRelatedOperations","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"CBRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/140648659841806337"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"effects":{"href":"https://horizon.stellar.org/operations/140648659841806337/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=140648659841806337"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=140648659841806337"}},"id":"140648659841806337","paging_token":"140648659841806337","transaction_successful":true,"source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","type":"create_claimable_balance","type_i":14,"created_at":"2020-11-23T16:02:38Z","transaction_hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","sponsor":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","asset":"BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","amount":"0.1000000","claimants":[{"destination":"GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD","predicate":{"unconditional":true}}]}]}}}}}}}},"method":"get","path":"/claimable_balances/{claimable_balance_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/cb-retrieve-related-transactions.api.mdx b/api/horizon/resources/cb-retrieve-related-transactions.api.mdx index 1ebac2bd9..905aa85ea 100644 --- a/api/horizon/resources/cb-retrieve-related-transactions.api.mdx +++ b/api/horizon/resources/cb-retrieve-related-transactions.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful transactions referencing a giv sidebar_label: "Retrieve Related Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"CBRetrieveRelatedTransactions","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"CBRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"account":{"href":"https://horizon.stellar.org/accounts/GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF"},"ledger":{"href":"https://horizon.stellar.org/ledgers/32747318"},"operations":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=140648659841806336"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=140648659841806336"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"}},"id":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","paging_token":"140648659841806336","successful":true,"hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","ledger":32747318,"created_at":"2020-11-23T16:02:38Z","source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","source_account_sequence":"140646847365513218","fee_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAgAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAGQB862QAAAAAgAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAADgAAAAJCT0RISQAAAAAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAA9CQAAAAAEAAAAAAAAAAElBqA1BXzKd9k9nuPoodv0YBKY+Hgh6Uz/UxozgnvyzAAAAAAAAAAAAAAABYYRX4AAAAEDf41ykW+eq8IVpJNOc4iDaht5Beil8NpQB8WMHkOxW3rocUBF3EHKqUXDIsD9CzzY7Xr1PbzVk5FZ4iBKNF4MM","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAOAAAAAAAAAAAXiCb7/jOeH1xTQXxv7f4sBei+wUMDFD7EaziYGwnD+QAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAAAAAAAQHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAwHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEB8682AAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycJUAfOtkAAAAAIAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAfOvNgAAAAQAAAAAF4gm+/4znh9cU0F8b+3+LAXovsFDAxQ+xGs4mBsJw/kAAAABAAAAAAAAAABJQagNQV8ynfZPZ7j6KHb9GASmPh4IelM/1MaM4J78swAAAAAAAAACQk9ESEkAAAAAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAAPQkAAAAAAAAAAAQAAAAEAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMB866UAAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycK4AfOtkAAAAAEAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAAAAAAAAAAABAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAA","memo_type":"none","signatures":["3+NcpFvnqvCFaSTTnOIg2obeQXopfDaUAfFjB5DsVt66HFARdxByqlFwyLA/Qs82O169T281ZORWeIgSjReDDA=="],"valid_after":"1970-01-01T00:00:00Z","preconditions":{"timebounds":{"min_time":"0"}}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/claimable_balances/{claimable_balance_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"CBRetrieveRelatedTransactions","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"CBRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"account":{"href":"https://horizon.stellar.org/accounts/GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF"},"ledger":{"href":"https://horizon.stellar.org/ledgers/32747318"},"operations":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=140648659841806336"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=140648659841806336"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"}},"id":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","paging_token":"140648659841806336","successful":true,"hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","ledger":32747318,"created_at":"2020-11-23T16:02:38Z","source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","source_account_sequence":"140646847365513218","fee_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAgAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAGQB862QAAAAAgAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAADgAAAAJCT0RISQAAAAAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAA9CQAAAAAEAAAAAAAAAAElBqA1BXzKd9k9nuPoodv0YBKY+Hgh6Uz/UxozgnvyzAAAAAAAAAAAAAAABYYRX4AAAAEDf41ykW+eq8IVpJNOc4iDaht5Beil8NpQB8WMHkOxW3rocUBF3EHKqUXDIsD9CzzY7Xr1PbzVk5FZ4iBKNF4MM","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAOAAAAAAAAAAAXiCb7/jOeH1xTQXxv7f4sBei+wUMDFD7EaziYGwnD+QAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAAAAAAAQHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAwHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEB8682AAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycJUAfOtkAAAAAIAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAfOvNgAAAAQAAAAAF4gm+/4znh9cU0F8b+3+LAXovsFDAxQ+xGs4mBsJw/kAAAABAAAAAAAAAABJQagNQV8ynfZPZ7j6KHb9GASmPh4IelM/1MaM4J78swAAAAAAAAACQk9ESEkAAAAAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAAPQkAAAAAAAAAAAQAAAAEAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMB866UAAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycK4AfOtkAAAAAEAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAAAAAAAAAAABAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAA","memo_type":"none","signatures":["3+NcpFvnqvCFaSTTnOIg2obeQXopfDaUAfFjB5DsVt66HFARdxByqlFwyLA/Qs82O169T281ZORWeIgSjReDDA=="],"valid_after":"1970-01-01T00:00:00Z","preconditions":{"timebounds":{"min_time":"0"}}}]}}}}}}}},"method":"get","path":"/claimable_balances/{claimable_balance_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-all-offers.api.mdx b/api/horizon/resources/get-all-offers.api.mdx index a1d53746d..b9218ea34 100644 --- a/api/horizon/resources/get-all-offers.api.mdx +++ b/api/horizon/resources/get-all-offers.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all currently open offers and can be used in s sidebar_label: "List All Offers" hide_title: true hide_table_of_contents: true -api: {"tags":["Offers"],"description":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","operationId":"GetAllOffers","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"seller","in":"query","required":false,"description":"The account ID of the offer creator."},{"name":"selling_asset_type","in":"query","required":false,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"GetAllOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers?cursor=&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"next":{"href":"https://horizon.stellar.org/offers?cursor=88345152&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"prev":{"href":"https://horizon.stellar.org/offers?cursor=71673427&limit=3&order=desc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/71673427"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7"}},"id":71673427,"paging_token":"71673427","seller":"GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"},"amount":"25.6545775","price_r":{"n":289696073,"d":25654776},"price":"11.2920913","last_modified_ledger":26981646,"last_modified_time":"2019-11-26T13:42:10Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88328208"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R"}},"id":88328208,"paging_token":"88328208","seller":"GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"},"amount":"2.4664893","price_r":{"n":500,"d":1233},"price":"0.4055150","last_modified_ledger":23886660,"last_modified_time":"2019-05-17T00:33:16Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88345152"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U"}},"id":88345152,"paging_token":"88345152","seller":"GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},"amount":"10.0000000","price_r":{"n":11,"d":10},"price":"1.1000000","last_modified_ledger":23887778,"last_modified_time":"2019-05-17T02:19:19Z"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Offers","description":{"content":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","type":"text/plain"},"url":{"path":["offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"The account ID of the offer creator.","type":"text/plain"},"key":"seller","value":""},{"disabled":false,"description":{"content":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"selling_asset_type","value":""},{"description":{"content":"The Stellar address of the selling asset’s issuer.","type":"text/plain"},"key":"selling_asset_issuer","value":""},{"description":{"content":"The code for the selling asset.","type":"text/plain"},"key":"selling_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"buying_asset_type","value":""},{"description":{"content":"The Stellar address of the buying asset’s issuer.","type":"text/plain"},"key":"buying_asset_issuer","value":""},{"description":{"content":"The code for the buying asset.","type":"text/plain"},"key":"buying_asset_code","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Offers"],"description":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","operationId":"GetAllOffers","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"seller","in":"query","required":false,"description":"The account ID of the offer creator."},{"name":"selling_asset_type","in":"query","required":false,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"GetAllOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers?cursor=&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"next":{"href":"https://horizon.stellar.org/offers?cursor=88345152&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"prev":{"href":"https://horizon.stellar.org/offers?cursor=71673427&limit=3&order=desc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/71673427"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7"}},"id":71673427,"paging_token":"71673427","seller":"GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"},"amount":"25.6545775","price_r":{"n":289696073,"d":25654776},"price":"11.2920913","last_modified_ledger":26981646,"last_modified_time":"2019-11-26T13:42:10Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88328208"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R"}},"id":88328208,"paging_token":"88328208","seller":"GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"},"amount":"2.4664893","price_r":{"n":500,"d":1233},"price":"0.4055150","last_modified_ledger":23886660,"last_modified_time":"2019-05-17T00:33:16Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88345152"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U"}},"id":88345152,"paging_token":"88345152","seller":"GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},"amount":"10.0000000","price_r":{"n":11,"d":10},"price":"1.1000000","last_modified_ledger":23887778,"last_modified_time":"2019-05-17T02:19:19Z"}]}}}}}}}},"method":"get","path":"/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Offers","description":{"content":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","type":"text/plain"},"url":{"path":["offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"The account ID of the offer creator.","type":"text/plain"},"key":"seller","value":""},{"disabled":false,"description":{"content":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"selling_asset_type","value":""},{"description":{"content":"The Stellar address of the selling asset’s issuer.","type":"text/plain"},"key":"selling_asset_issuer","value":""},{"description":{"content":"The code for the selling asset.","type":"text/plain"},"key":"selling_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"buying_asset_type","value":""},{"description":{"content":"The Stellar address of the buying asset’s issuer.","type":"text/plain"},"key":"buying_asset_issuer","value":""},{"description":{"content":"The code for the buying asset.","type":"text/plain"},"key":"buying_asset_code","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-all-trades.api.mdx b/api/horizon/resources/get-all-trades.api.mdx index be13243b6..b31740b8f 100644 --- a/api/horizon/resources/get-all-trades.api.mdx +++ b/api/horizon/resources/get-all-trades.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all trades and can be used in streaming mode. sidebar_label: "List All Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Trades"],"description":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"GetAllTrades","parameters":[{"name":"offer_id","in":"query","required":false,"description":"The offer ID. Used to filter for trades originating from a specific offer."},{"name":"base_asset_type","in":"query","required":false,"description":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"base_asset_issuer","in":"query","required":false,"description":"The Stellar address of the base asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"base_asset_code","in":"query","required":false,"description":"The code for the base asset.","schema":{"type":"string","example":"USD"}},{"name":"counter_asset_type","in":"query","required":false,"description":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"counter_asset_issuer","in":"query","required":false,"description":"The Stellar address of the counter asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"counter_asset_code","in":"query","required":false,"description":"The code for the counter asset."},{"name":"trade_type","in":"query","required":false,"description":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","schema":{"type":"string","enum":["all","orderbook","liquidity_pools"]}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetAllTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=83056000260648961-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=82854686553571330-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T"},"operation":{"href":"https://horizon.stellar.org/operations/82854686553571330"}},"id":"82854686553571330-0","paging_token":"82854686553571330-0","ledger_close_time":"2018-08-05T00:55:34Z","offer_id":"23074703","base_offer_id":"23074703","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"22.9174941","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694540704980959234","counter_account":"GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T","counter_amount":"97.9999800","counter_asset_type":"native","base_is_seller":true,"price":{"n":"106905209","d":"25000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU"},"operation":{"href":"https://horizon.stellar.org/operations/83005225157287937"}},"id":"83005225157287937-0","paging_token":"83005225157287937-0","ledger_close_time":"2018-08-07T02:01:53Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694691243584675841","counter_account":"GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY"},"operation":{"href":"https://horizon.stellar.org/operations/83056000260648961"}},"id":"83056000260648961-0","paging_token":"83056000260648961-0","ledger_close_time":"2018-08-07T18:27:33Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694742018688036865","counter_account":"GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Trades","description":{"content":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","type":"text/plain"},"url":{"path":["trades"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The offer ID. Used to filter for trades originating from a specific offer.","type":"text/plain"},"key":"offer_id","value":""},{"disabled":false,"description":{"content":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"base_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the base asset’s issuer.","type":"text/plain"},"key":"base_asset_issuer","value":""},{"disabled":false,"description":{"content":"The code for the base asset.","type":"text/plain"},"key":"base_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"counter_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the counter asset’s issuer.","type":"text/plain"},"key":"counter_asset_issuer","value":""},{"description":{"content":"The code for the counter asset.","type":"text/plain"},"key":"counter_asset_code","value":""},{"disabled":false,"description":{"content":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","type":"text/plain"},"key":"trade_type","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Trades"],"description":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"GetAllTrades","parameters":[{"name":"offer_id","in":"query","required":false,"description":"The offer ID. Used to filter for trades originating from a specific offer."},{"name":"base_asset_type","in":"query","required":false,"description":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"base_asset_issuer","in":"query","required":false,"description":"The Stellar address of the base asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"base_asset_code","in":"query","required":false,"description":"The code for the base asset.","schema":{"type":"string","example":"USD"}},{"name":"counter_asset_type","in":"query","required":false,"description":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"counter_asset_issuer","in":"query","required":false,"description":"The Stellar address of the counter asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"counter_asset_code","in":"query","required":false,"description":"The code for the counter asset."},{"name":"trade_type","in":"query","required":false,"description":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","schema":{"type":"string","enum":["all","orderbook","liquidity_pools"]}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetAllTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=83056000260648961-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=82854686553571330-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T"},"operation":{"href":"https://horizon.stellar.org/operations/82854686553571330"}},"id":"82854686553571330-0","paging_token":"82854686553571330-0","ledger_close_time":"2018-08-05T00:55:34Z","offer_id":"23074703","base_offer_id":"23074703","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"22.9174941","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694540704980959234","counter_account":"GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T","counter_amount":"97.9999800","counter_asset_type":"native","base_is_seller":true,"price":{"n":"106905209","d":"25000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU"},"operation":{"href":"https://horizon.stellar.org/operations/83005225157287937"}},"id":"83005225157287937-0","paging_token":"83005225157287937-0","ledger_close_time":"2018-08-07T02:01:53Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694691243584675841","counter_account":"GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY"},"operation":{"href":"https://horizon.stellar.org/operations/83056000260648961"}},"id":"83056000260648961-0","paging_token":"83056000260648961-0","ledger_close_time":"2018-08-07T18:27:33Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694742018688036865","counter_account":"GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}}]}}}}}}}},"method":"get","path":"/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Trades","description":{"content":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","type":"text/plain"},"url":{"path":["trades"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The offer ID. Used to filter for trades originating from a specific offer.","type":"text/plain"},"key":"offer_id","value":""},{"disabled":false,"description":{"content":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"base_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the base asset’s issuer.","type":"text/plain"},"key":"base_asset_issuer","value":""},{"disabled":false,"description":{"content":"The code for the base asset.","type":"text/plain"},"key":"base_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"counter_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the counter asset’s issuer.","type":"text/plain"},"key":"counter_asset_issuer","value":""},{"description":{"content":"The code for the counter asset.","type":"text/plain"},"key":"counter_asset_code","value":""},{"disabled":false,"description":{"content":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","type":"text/plain"},"key":"trade_type","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-effects-by-account-id.api.mdx b/api/horizon/resources/get-effects-by-account-id.api.mdx index 649126e93..f21bb9c55 100644 --- a/api/horizon/resources/get-effects-by-account-id.api.mdx +++ b/api/horizon/resources/get-effects-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint returns the effects of a specific account and can be sidebar_label: "Retrieve an Account's Effects" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"GetEffectsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=147350483860869151-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=110694007436259329-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-1"}},"id":"0110694007436259329-0000000001","paging_token":"110694007436259329-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_created","type_i":0,"created_at":"2019-09-11T13:16:44Z","starting_balance":"1.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-3"}},"id":"0110694007436259329-0000000003","paging_token":"110694007436259329-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"signer_created","type_i":10,"created_at":"2019-09-11T13:16:44Z","weight":1,"public_key":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330-2"}},"id":"0110694007436259330-0000000002","paging_token":"110694007436259330-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-09-11T13:16:44Z","asset_type":"native","amount":"355.2904739"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841-1"}},"id":"0115354197276323841-0000000001","paging_token":"115354197276323841-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-11-18T19:59:40Z","asset_type":"native","amount":"688.4065454"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801-1"}},"id":"0117356420835532801-0000000001","paging_token":"117356420835532801-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-12-18T08:23:35Z","asset_type":"native","amount":"355.3887598"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811393"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811393-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811393-1"}},"id":"0119399833130811393-0000000001","paging_token":"119399833130811393-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trustline_created","type_i":20,"created_at":"2020-01-17T20:13:22Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-1"}},"id":"0119399833130811394-0000000001","paging_token":"119399833130811394-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GCM4PT6XDZBWOOENDS6FOU22GJQLJPV2GC7VRVII4TFGZBA3ZXNM55SV","offer_id":"147625249","sold_amount":"539.0320108","sold_asset_type":"native","bought_amount":"32.8490620","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-3"}},"id":"0119399833130811394-0000000003","paging_token":"119399833130811394-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GBDVKE33GVVMBXX73OHIBRP6RAHKHHW2P4PQVV6UNOKQCOXU7GNUM4QI","offer_id":"147618811","sold_amount":"854.9537682","sold_asset_type":"native","bought_amount":"52.0920258","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665-2"}},"id":"0119400713599217665-0000000002","paging_token":"119400713599217665-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_debited","type_i":3,"created_at":"2020-01-17T20:32:38Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","amount":"84.9410878"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151-1"}},"id":"0147350483860869151-0000000001","paging_token":"147350483860869151-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2021-03-06T19:27:33Z","asset_type":"native","amount":"0.0000001"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Effects","description":{"content":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"GetEffectsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=147350483860869151-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=110694007436259329-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-1"}},"id":"0110694007436259329-0000000001","paging_token":"110694007436259329-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_created","type_i":0,"created_at":"2019-09-11T13:16:44Z","starting_balance":"1.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-3"}},"id":"0110694007436259329-0000000003","paging_token":"110694007436259329-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"signer_created","type_i":10,"created_at":"2019-09-11T13:16:44Z","weight":1,"public_key":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330-2"}},"id":"0110694007436259330-0000000002","paging_token":"110694007436259330-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-09-11T13:16:44Z","asset_type":"native","amount":"355.2904739"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841-1"}},"id":"0115354197276323841-0000000001","paging_token":"115354197276323841-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-11-18T19:59:40Z","asset_type":"native","amount":"688.4065454"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801-1"}},"id":"0117356420835532801-0000000001","paging_token":"117356420835532801-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-12-18T08:23:35Z","asset_type":"native","amount":"355.3887598"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811393"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811393-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811393-1"}},"id":"0119399833130811393-0000000001","paging_token":"119399833130811393-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trustline_created","type_i":20,"created_at":"2020-01-17T20:13:22Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-1"}},"id":"0119399833130811394-0000000001","paging_token":"119399833130811394-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GCM4PT6XDZBWOOENDS6FOU22GJQLJPV2GC7VRVII4TFGZBA3ZXNM55SV","offer_id":"147625249","sold_amount":"539.0320108","sold_asset_type":"native","bought_amount":"32.8490620","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-3"}},"id":"0119399833130811394-0000000003","paging_token":"119399833130811394-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GBDVKE33GVVMBXX73OHIBRP6RAHKHHW2P4PQVV6UNOKQCOXU7GNUM4QI","offer_id":"147618811","sold_amount":"854.9537682","sold_asset_type":"native","bought_amount":"52.0920258","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665-2"}},"id":"0119400713599217665-0000000002","paging_token":"119400713599217665-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_debited","type_i":3,"created_at":"2020-01-17T20:32:38Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","amount":"84.9410878"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151-1"}},"id":"0147350483860869151-0000000001","paging_token":"147350483860869151-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2021-03-06T19:27:33Z","asset_type":"native","amount":"0.0000001"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Effects","description":{"content":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-offers-by-account-id.api.mdx b/api/horizon/resources/get-offers-by-account-id.api.mdx index 4947bbd20..893798d4f 100644 --- a/api/horizon/resources/get-offers-by-account-id.api.mdx +++ b/api/horizon/resources/get-offers-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents all offers a given account has currently sidebar_label: "Retrieve an Account's Offers" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents all offers a given account has currently open and can be used in streaming mode. Streaming mode allows you to listen for new offers for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time.","operationId":"GetOffersByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"RetrieveAnAccountsOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164555927&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/164555927"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"}},"id":164555927,"paging_token":"164555927","seller":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","selling":{"asset_type":"native"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"},"amount":"214.9999939","price_r":{"n":10000000,"d":86000001},"price":"0.1162791","last_modified_ledger":28383147,"last_modified_time":"2020-02-24T22:58:38Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/164943216"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"}},"id":164943216,"paging_token":"164943216","seller":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","selling":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"},"buying":{"asset_type":"native"},"amount":"24.9999990","price_r":{"n":32224991,"d":2500000},"price":"12.8899964","last_modified_ledger":28394149,"last_modified_time":"2020-02-25T15:49:57Z"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Offers","description":{"content":"This endpoint represents all offers a given account has currently open and can be used in streaming mode. Streaming mode allows you to listen for new offers for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents all offers a given account has currently open and can be used in streaming mode. Streaming mode allows you to listen for new offers for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time.","operationId":"GetOffersByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"RetrieveAnAccountsOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164555927&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/164555927"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"}},"id":164555927,"paging_token":"164555927","seller":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","selling":{"asset_type":"native"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"},"amount":"214.9999939","price_r":{"n":10000000,"d":86000001},"price":"0.1162791","last_modified_ledger":28383147,"last_modified_time":"2020-02-24T22:58:38Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/164943216"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"}},"id":164943216,"paging_token":"164943216","seller":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","selling":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"},"buying":{"asset_type":"native"},"amount":"24.9999990","price_r":{"n":32224991,"d":2500000},"price":"12.8899964","last_modified_ledger":28394149,"last_modified_time":"2020-02-25T15:49:57Z"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Offers","description":{"content":"This endpoint represents all offers a given account has currently open and can be used in streaming mode. Streaming mode allows you to listen for new offers for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-operations-by-account-id.api.mdx b/api/horizon/resources/get-operations-by-account-id.api.mdx index b4d80bb1b..fec92914e 100644 --- a/api/horizon/resources/get-operations-by-account-id.api.mdx +++ b/api/horizon/resources/get-operations-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful operations for a given account sidebar_label: "Retrieve an Account's Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"GetOperationsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120194466505179137&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120192344791343105&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192344791343105"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"effects":{"href":"https://horizon.stellar.org/operations/120192344791343105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192344791343105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192344791343105"}},"id":"120192344791343105","paging_token":"120192344791343105","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"create_account","type_i":0,"created_at":"2020-01-29T19:43:59Z","transaction_hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","starting_balance":"2.0000000","funder":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192370561220609"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"effects":{"href":"https://horizon.stellar.org/operations/120192370561220609/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192370561220609"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192370561220609"}},"id":"120192370561220609","paging_token":"120192370561220609","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"payment","type_i":1,"created_at":"2020-01-29T19:44:36Z","transaction_hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","asset_type":"native","from":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","to":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","amount":"200.0000000"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192452165550081"},"transaction":{"href":"https://horizon.stellar.org/transactions/0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3"},"effects":{"href":"https://horizon.stellar.org/operations/120192452165550081/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192452165550081"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192452165550081"}},"id":"120192452165550081","paging_token":"120192452165550081","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:20Z","transaction_hash":"0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775807","trustee":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192477935251457"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23"},"effects":{"href":"https://horizon.stellar.org/operations/120192477935251457/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192477935251457"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192477935251457"}},"id":"120192477935251457","paging_token":"120192477935251457","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:55Z","transaction_hash":"ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23","asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","limit":"922337203685.4775807","trustee":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192490820268033"},"transaction":{"href":"https://horizon.stellar.org/transactions/81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff"},"effects":{"href":"https://horizon.stellar.org/operations/120192490820268033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192490820268033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192490820268033"}},"id":"120192490820268033","paging_token":"120192490820268033","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:11Z","transaction_hash":"81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff","asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","limit":"922337203685.4775807","trustee":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192499410071553"},"transaction":{"href":"https://horizon.stellar.org/transactions/34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e"},"effects":{"href":"https://horizon.stellar.org/operations/120192499410071553/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192499410071553"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192499410071553"}},"id":"120192499410071553","paging_token":"120192499410071553","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:22Z","transaction_hash":"34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e","asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","limit":"922337203685.4775807","trustee":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192508000047105"},"transaction":{"href":"https://horizon.stellar.org/transactions/12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917"},"effects":{"href":"https://horizon.stellar.org/operations/120192508000047105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192508000047105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192508000047105"}},"id":"120192508000047105","paging_token":"120192508000047105","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:33Z","transaction_hash":"12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"922337203685.4775807","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192542359883777"},"transaction":{"href":"https://horizon.stellar.org/transactions/36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580"},"effects":{"href":"https://horizon.stellar.org/operations/120192542359883777/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192542359883777"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192542359883777"}},"id":"120192542359883777","paging_token":"120192542359883777","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:16Z","transaction_hash":"36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580","amount":"3.0000000","price":"18.1088911","price_r":{"n":181088911,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"EURT","buying_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192568129794049"},"transaction":{"href":"https://horizon.stellar.org/transactions/f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340"},"effects":{"href":"https://horizon.stellar.org/operations/120192568129794049/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192568129794049"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192568129794049"}},"id":"120192568129794049","paging_token":"120192568129794049","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:54Z","transaction_hash":"f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340","amount":"200.0000000","price":"0.0459893","price_r":{"n":459893,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"NGNT","buying_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120194466505179137"},"transaction":{"href":"https://horizon.stellar.org/transactions/a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d"},"effects":{"href":"https://horizon.stellar.org/operations/120194466505179137/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120194466505179137"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120194466505179137"}},"id":"120194466505179137","paging_token":"120194466505179137","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T20:31:28Z","transaction_hash":"a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"0.0000000","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Operations","description":{"content":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"GetOperationsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120194466505179137&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120192344791343105&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192344791343105"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"effects":{"href":"https://horizon.stellar.org/operations/120192344791343105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192344791343105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192344791343105"}},"id":"120192344791343105","paging_token":"120192344791343105","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"create_account","type_i":0,"created_at":"2020-01-29T19:43:59Z","transaction_hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","starting_balance":"2.0000000","funder":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192370561220609"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"effects":{"href":"https://horizon.stellar.org/operations/120192370561220609/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192370561220609"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192370561220609"}},"id":"120192370561220609","paging_token":"120192370561220609","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"payment","type_i":1,"created_at":"2020-01-29T19:44:36Z","transaction_hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","asset_type":"native","from":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","to":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","amount":"200.0000000"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192452165550081"},"transaction":{"href":"https://horizon.stellar.org/transactions/0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3"},"effects":{"href":"https://horizon.stellar.org/operations/120192452165550081/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192452165550081"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192452165550081"}},"id":"120192452165550081","paging_token":"120192452165550081","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:20Z","transaction_hash":"0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775807","trustee":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192477935251457"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23"},"effects":{"href":"https://horizon.stellar.org/operations/120192477935251457/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192477935251457"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192477935251457"}},"id":"120192477935251457","paging_token":"120192477935251457","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:55Z","transaction_hash":"ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23","asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","limit":"922337203685.4775807","trustee":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192490820268033"},"transaction":{"href":"https://horizon.stellar.org/transactions/81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff"},"effects":{"href":"https://horizon.stellar.org/operations/120192490820268033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192490820268033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192490820268033"}},"id":"120192490820268033","paging_token":"120192490820268033","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:11Z","transaction_hash":"81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff","asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","limit":"922337203685.4775807","trustee":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192499410071553"},"transaction":{"href":"https://horizon.stellar.org/transactions/34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e"},"effects":{"href":"https://horizon.stellar.org/operations/120192499410071553/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192499410071553"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192499410071553"}},"id":"120192499410071553","paging_token":"120192499410071553","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:22Z","transaction_hash":"34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e","asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","limit":"922337203685.4775807","trustee":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192508000047105"},"transaction":{"href":"https://horizon.stellar.org/transactions/12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917"},"effects":{"href":"https://horizon.stellar.org/operations/120192508000047105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192508000047105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192508000047105"}},"id":"120192508000047105","paging_token":"120192508000047105","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:33Z","transaction_hash":"12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"922337203685.4775807","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192542359883777"},"transaction":{"href":"https://horizon.stellar.org/transactions/36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580"},"effects":{"href":"https://horizon.stellar.org/operations/120192542359883777/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192542359883777"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192542359883777"}},"id":"120192542359883777","paging_token":"120192542359883777","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:16Z","transaction_hash":"36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580","amount":"3.0000000","price":"18.1088911","price_r":{"n":181088911,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"EURT","buying_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192568129794049"},"transaction":{"href":"https://horizon.stellar.org/transactions/f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340"},"effects":{"href":"https://horizon.stellar.org/operations/120192568129794049/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192568129794049"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192568129794049"}},"id":"120192568129794049","paging_token":"120192568129794049","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:54Z","transaction_hash":"f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340","amount":"200.0000000","price":"0.0459893","price_r":{"n":459893,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"NGNT","buying_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120194466505179137"},"transaction":{"href":"https://horizon.stellar.org/transactions/a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d"},"effects":{"href":"https://horizon.stellar.org/operations/120194466505179137/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120194466505179137"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120194466505179137"}},"id":"120194466505179137","paging_token":"120194466505179137","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T20:31:28Z","transaction_hash":"a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"0.0000000","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Operations","description":{"content":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-payments-by-account-id.api.mdx b/api/horizon/resources/get-payments-by-account-id.api.mdx index 20cb0f467..4386cf1b6 100644 --- a/api/horizon/resources/get-payments-by-account-id.api.mdx +++ b/api/horizon/resources/get-payments-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful payments for a given account a sidebar_label: "Retrieve an Account's Payments" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","operationId":"GetPaymentsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"}]},"examples":{"RetrieveAnAccountsPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=148289273518190684&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=110694007436259329&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259329/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329"}},"id":"110694007436259329","paging_token":"110694007436259329","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"create_account","type_i":0,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","starting_balance":"1.0000000","funder":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259330/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330"}},"id":"110694007436259330","paging_token":"110694007436259330","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"account_merge","type_i":8,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","into":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"transaction":{"href":"https://horizon.stellar.org/transactions/c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b"},"effects":{"href":"https://horizon.stellar.org/operations/115354197276323841/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841"}},"id":"115354197276323841","paging_token":"115354197276323841","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-11-18T19:59:40Z","transaction_hash":"c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"688.4065454"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"transaction":{"href":"https://horizon.stellar.org/transactions/c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00"},"effects":{"href":"https://horizon.stellar.org/operations/117356420835532801/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801"}},"id":"117356420835532801","paging_token":"117356420835532801","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-12-18T08:23:35Z","transaction_hash":"c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"355.3887598"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"transaction":{"href":"https://horizon.stellar.org/transactions/b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f"},"effects":{"href":"https://horizon.stellar.org/operations/119400713599217665/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665"}},"id":"119400713599217665","paging_token":"119400713599217665","transaction_successful":true,"source_account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"payment","type_i":1,"created_at":"2020-01-17T20:32:38Z","transaction_hash":"b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","from":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","to":"GASWJWFRYE55KC7MGANZMMRBK5NPXT3HMPDQ6SEXZN6ZPWYXVVYBFRTE","amount":"84.9410878"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"transaction":{"href":"https://horizon.stellar.org/transactions/b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193"},"effects":{"href":"https://horizon.stellar.org/operations/147350483860869151/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151"}},"id":"147350483860869151","paging_token":"147350483860869151","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T19:27:33Z","transaction_hash":"b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147354181828010015"},"transaction":{"href":"https://horizon.stellar.org/transactions/1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e"},"effects":{"href":"https://horizon.stellar.org/operations/147354181828010015/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147354181828010015"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147354181828010015"}},"id":"147354181828010015","paging_token":"147354181828010015","transaction_successful":true,"source_account":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","type":"payment","type_i":1,"created_at":"2021-03-06T20:49:34Z","transaction_hash":"1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e","asset_type":"native","from":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147355590577238047"},"transaction":{"href":"https://horizon.stellar.org/transactions/ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947"},"effects":{"href":"https://horizon.stellar.org/operations/147355590577238047/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147355590577238047"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147355590577238047"}},"id":"147355590577238047","paging_token":"147355590577238047","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T21:19:49Z","transaction_hash":"ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148286782436462682"},"transaction":{"href":"https://horizon.stellar.org/transactions/74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1"},"effects":{"href":"https://horizon.stellar.org/operations/148286782436462682/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148286782436462682"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148286782436462682"}},"id":"148286782436462682","paging_token":"148286782436462682","transaction_successful":true,"source_account":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","type":"payment","type_i":1,"created_at":"2021-03-20T12:48:24Z","transaction_hash":"74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1","asset_type":"native","from":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148289273518190684"},"transaction":{"href":"https://horizon.stellar.org/transactions/de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49"},"effects":{"href":"https://horizon.stellar.org/operations/148289273518190684/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148289273518190684"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148289273518190684"}},"id":"148289273518190684","paging_token":"148289273518190684","transaction_successful":true,"source_account":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","type":"payment","type_i":1,"created_at":"2021-03-20T13:42:07Z","transaction_hash":"de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49","asset_type":"native","from":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Payments","description":{"content":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","operationId":"GetPaymentsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"}]},"examples":{"RetrieveAnAccountsPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=148289273518190684&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=110694007436259329&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259329/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329"}},"id":"110694007436259329","paging_token":"110694007436259329","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"create_account","type_i":0,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","starting_balance":"1.0000000","funder":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259330/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330"}},"id":"110694007436259330","paging_token":"110694007436259330","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"account_merge","type_i":8,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","into":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"transaction":{"href":"https://horizon.stellar.org/transactions/c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b"},"effects":{"href":"https://horizon.stellar.org/operations/115354197276323841/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841"}},"id":"115354197276323841","paging_token":"115354197276323841","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-11-18T19:59:40Z","transaction_hash":"c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"688.4065454"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"transaction":{"href":"https://horizon.stellar.org/transactions/c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00"},"effects":{"href":"https://horizon.stellar.org/operations/117356420835532801/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801"}},"id":"117356420835532801","paging_token":"117356420835532801","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-12-18T08:23:35Z","transaction_hash":"c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"355.3887598"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"transaction":{"href":"https://horizon.stellar.org/transactions/b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f"},"effects":{"href":"https://horizon.stellar.org/operations/119400713599217665/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665"}},"id":"119400713599217665","paging_token":"119400713599217665","transaction_successful":true,"source_account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"payment","type_i":1,"created_at":"2020-01-17T20:32:38Z","transaction_hash":"b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","from":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","to":"GASWJWFRYE55KC7MGANZMMRBK5NPXT3HMPDQ6SEXZN6ZPWYXVVYBFRTE","amount":"84.9410878"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"transaction":{"href":"https://horizon.stellar.org/transactions/b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193"},"effects":{"href":"https://horizon.stellar.org/operations/147350483860869151/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151"}},"id":"147350483860869151","paging_token":"147350483860869151","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T19:27:33Z","transaction_hash":"b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147354181828010015"},"transaction":{"href":"https://horizon.stellar.org/transactions/1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e"},"effects":{"href":"https://horizon.stellar.org/operations/147354181828010015/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147354181828010015"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147354181828010015"}},"id":"147354181828010015","paging_token":"147354181828010015","transaction_successful":true,"source_account":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","type":"payment","type_i":1,"created_at":"2021-03-06T20:49:34Z","transaction_hash":"1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e","asset_type":"native","from":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147355590577238047"},"transaction":{"href":"https://horizon.stellar.org/transactions/ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947"},"effects":{"href":"https://horizon.stellar.org/operations/147355590577238047/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147355590577238047"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147355590577238047"}},"id":"147355590577238047","paging_token":"147355590577238047","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T21:19:49Z","transaction_hash":"ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148286782436462682"},"transaction":{"href":"https://horizon.stellar.org/transactions/74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1"},"effects":{"href":"https://horizon.stellar.org/operations/148286782436462682/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148286782436462682"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148286782436462682"}},"id":"148286782436462682","paging_token":"148286782436462682","transaction_successful":true,"source_account":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","type":"payment","type_i":1,"created_at":"2021-03-20T12:48:24Z","transaction_hash":"74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1","asset_type":"native","from":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148289273518190684"},"transaction":{"href":"https://horizon.stellar.org/transactions/de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49"},"effects":{"href":"https://horizon.stellar.org/operations/148289273518190684/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148289273518190684"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148289273518190684"}},"id":"148289273518190684","paging_token":"148289273518190684","transaction_successful":true,"source_account":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","type":"payment","type_i":1,"created_at":"2021-03-20T13:42:07Z","transaction_hash":"de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49","asset_type":"native","from":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Payments","description":{"content":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-trades-by-account-id.api.mdx b/api/horizon/resources/get-trades-by-account-id.api.mdx index ec288015f..e95107e86 100644 --- a/api/horizon/resources/get-trades-by-account-id.api.mdx +++ b/api/horizon/resources/get-trades-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents all trades for a given account and can be sidebar_label: "Retrieve an Account's Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents all trades for a given account and can be used in streaming mode. Streaming mode allows you to listen for trades for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","operationId":"GetTradesByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveAnAccountsTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449468881756161"}},"id":"107449468881756161-0","paging_token":"107449468881756161-0","ledger_close_time":"2019-07-26T09:17:02Z","trade_type":"orderbook","base_offer_id":"104078276","base_account":"GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX","base_amount":"4433.2000000","base_asset_type":"native","counter_offer_id":"4719135487309144065","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"443.3200000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"1","d":"10"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449486061649921"}},"id":"107449486061649921-0","paging_token":"107449486061649921-0","ledger_close_time":"2019-07-26T09:17:25Z","trade_type":"orderbook","base_offer_id":"104273938","base_account":"GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B","base_amount":"10.0000000","base_asset_type":"native","counter_offer_id":"4719135504489037825","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"1.0000000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"1","d":"10"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449584845914113"}},"id":"107449584845914113-0","paging_token":"107449584845914113-0","ledger_close_time":"2019-07-26T09:19:30Z","trade_type":"orderbook","base_offer_id":"104299223","base_account":"GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ","base_amount":"748.5338945","base_asset_type":"native","counter_offer_id":"104299548","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"74.8533887","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"10000000","d":"100000001"}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Trades","description":{"content":"This endpoint represents all trades for a given account and can be used in streaming mode. Streaming mode allows you to listen for trades for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents all trades for a given account and can be used in streaming mode. Streaming mode allows you to listen for trades for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","operationId":"GetTradesByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveAnAccountsTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449468881756161"}},"id":"107449468881756161-0","paging_token":"107449468881756161-0","ledger_close_time":"2019-07-26T09:17:02Z","trade_type":"orderbook","base_offer_id":"104078276","base_account":"GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX","base_amount":"4433.2000000","base_asset_type":"native","counter_offer_id":"4719135487309144065","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"443.3200000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"1","d":"10"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449486061649921"}},"id":"107449486061649921-0","paging_token":"107449486061649921-0","ledger_close_time":"2019-07-26T09:17:25Z","trade_type":"orderbook","base_offer_id":"104273938","base_account":"GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B","base_amount":"10.0000000","base_asset_type":"native","counter_offer_id":"4719135504489037825","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"1.0000000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"1","d":"10"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449584845914113"}},"id":"107449584845914113-0","paging_token":"107449584845914113-0","ledger_close_time":"2019-07-26T09:19:30Z","trade_type":"orderbook","base_offer_id":"104299223","base_account":"GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ","base_amount":"748.5338945","base_asset_type":"native","counter_offer_id":"104299548","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"74.8533887","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"10000000","d":"100000001"}}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Trades","description":{"content":"This endpoint represents all trades for a given account and can be used in streaming mode. Streaming mode allows you to listen for trades for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-trades-by-offer-id.api.mdx b/api/horizon/resources/get-trades-by-offer-id.api.mdx index 4612db6bc..15ba476f2 100644 --- a/api/horizon/resources/get-trades-by-offer-id.api.mdx +++ b/api/horizon/resources/get-trades-by-offer-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents all trades for a given offer and can be u sidebar_label: "Retrieve an Offer's Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Offers"],"description":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","operationId":"GetTradesByOfferId","parameters":[{"name":"offer_id","in":"path","required":true,"description":"A unique identifier for this offer."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetTradesByOfferId":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449468881756161"}},"id":"107449468881756161-0","paging_token":"107449468881756161-0","ledger_close_time":"2019-07-26T09:17:02Z","offer_id":"104078276","base_offer_id":"104078276","base_account":"GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX","base_amount":"4433.2000000","base_asset_type":"native","counter_offer_id":"4719135487309144065","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"443.3200000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":1,"d":10}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/offers/{offer_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Offer's Trades","description":{"content":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","type":"text/plain"},"url":{"path":["offers",":offer_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this offer.","type":"text/plain"},"type":"any","value":"","key":"offer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Offers"],"description":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","operationId":"GetTradesByOfferId","parameters":[{"name":"offer_id","in":"path","required":true,"description":"A unique identifier for this offer."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetTradesByOfferId":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449468881756161"}},"id":"107449468881756161-0","paging_token":"107449468881756161-0","ledger_close_time":"2019-07-26T09:17:02Z","offer_id":"104078276","base_offer_id":"104078276","base_account":"GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX","base_amount":"4433.2000000","base_asset_type":"native","counter_offer_id":"4719135487309144065","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"443.3200000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":1,"d":10}}]}}}}}}}},"method":"get","path":"/offers/{offer_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Offer's Trades","description":{"content":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.","type":"text/plain"},"url":{"path":["offers",":offer_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this offer.","type":"text/plain"},"type":"any","value":"","key":"offer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-transactions-by-account-id.api.mdx b/api/horizon/resources/get-transactions-by-account-id.api.mdx index fca31e86a..cb15643a0 100644 --- a/api/horizon/resources/get-transactions-by-account-id.api.mdx +++ b/api/horizon/resources/get-transactions-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful transactions for a given accou sidebar_label: "Retrieve an Account's Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"GetTransactionsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"RetrieveAnAccountsTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=122152984477229056&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=94658837230923776&limit=10&order=desc"}},"_embedded":{"records":[{"memo":"","memo_bytes":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"},"account":{"href":"https://horizon.stellar.org/accounts/GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR"},"ledger":{"href":"https://horizon.stellar.org/ledgers/22039478"},"operations":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=94658837230923776"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=94658837230923776"},"transaction":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"}},"id":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","paging_token":"94658837230923776","successful":true,"hash":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","ledger":22039478,"created_at":"2019-01-18T14:40:47Z","source_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","source_account_sequence":"90296735301107721","fee_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAHEnAZ8fNRZRvFiUIuG3zTZfzTVQ9NZH39J5v+giP4ZOAAAAZAFAzGcAAAAJAAAAAQAAAAAAAAAAAAAAAFxB5cMAAAABAAAAAAAAAAEAAAAAAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAAAAAAAAAAEiP4ZOAAAAQO421wcb/JYfBpnYEJzHpMyQnrM8rHd4PUoyHXpPlvQAUGzARqwbX8hcLSM4tlk51AwbuZOaZfWCaFQfzFZJuAA=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAIAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAJAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAg2BPkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBUCemAAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wTIAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["7jbXBxv8lh8GmdgQnMekzJCeszysd3g9SjIdek+W9ABQbMBGrBtfyFwtIzi2WTnUDBu5k5pl9YJoVB/MVkm4AA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-01-18T14:42:11Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1547822531"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"},"account":{"href":"https://horizon.stellar.org/accounts/GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX"},"ledger":{"href":"https://horizon.stellar.org/ledgers/23895910"},"operations":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=102632151958179840"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=102632151958179840"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"}},"id":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","paging_token":"102632151958179840","successful":true,"hash":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","ledger":23895910,"created_at":"2019-05-17T14:43:53Z","source_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","source_account_sequence":"93143259236270083","fee_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAABftGINkC2jBebpVPlixLNCnvmLQFyHztWK/mlM1De1rAAAAZAFK6U0AAAADAAAAAQAAAAAAAAAAAAAAAFzeydEAAAAAAAAAAQAAAAAAAAABAAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAAAAAAALLQXgAAAAAAAAAAAE1De1rAAAAQLFFYK9rGA2Um2Vwguj4Ra3T6gaeturf4Qw/0LcG/qa/oXZeu6s7ZrB3wVVJu0m123Z7zirYoo576IS8agzLKQQ=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAAAKupPUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBS+8PAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/Aw4AUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["sUVgr2sYDZSbZXCC6PhFrdPqBp626t/hDD/Qtwb+pr+hdl67qztmsHfBVUm7SbXbdnvOKtiijnvohLxqDMspBA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-05-17T14:48:49Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1558104529"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27114571"},"operations":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=116456195690164224"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=116456195690164224"},"transaction":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"}},"id":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","paging_token":"116456195690164224","successful":true,"hash":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","ledger":27114571,"created_at":"2019-12-04T22:03:41Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911489","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAABAAAAAQAAAAAAAAAAAAAAAF3oLZMAAAAAAAAAAQAAAAAAAAABAAAAAARD8QZr6wa97ii5JeeuMJEXycVsEO1dBekjRTcI9AadAAAAAAAAAAABMS0AAAAAAAAAAAGXebqxAAAAQND+muz3883MoHmTtuhsDb4awF1U3EDJ2FQn8Ia2C9L+Rz62Z9EvH8rl81d3oPxrjUnedZmjOnptn6Agm5alHwc=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBnbwPAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAABxZQNiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAAByljBiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["0P6a7PfzzcygeZO26GwNvhrAXVTcQMnYVCfwhrYL0v5HPrZn0S8fyuXzV3eg/GuNSd51maM6em2foCCblqUfBw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-12-04T22:05:07Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1575497107"}}},{"memo":"hello universe","memo_bytes":"aGVsbG8gdW5pdmVyc2U=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984461"},"operations":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192344791343104"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192344791343104"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"}},"id":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","paging_token":"120192344791343104","successful":true,"hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","ledger":27984461,"created_at":"2020-01-29T19:43:59Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911490","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAACAAAAAQAAAAAAAAAAAAAAAF4x4NYAAAABAAAADmhlbGxvIHVuaXZlcnNlAAAAAAABAAAAAAAAAAAAAAAAMOWtdEZJweWBDrIVGDQOVodinrlXbfzBfquR7AFtxW4AAAAAATEtAAAAAAAAAAABl3m6sQAAAEDwdDlpQv5IfweTkLjytpWIa+bpQv7BAHRFpMCHscM3g+WBKjXPVEnSP1BghLuy3uhvgv4LnCkI+gFEDZxwV/YF","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["8HQ5aUL+SH8Hk5C48raViGvm6UL+wQB0RaTAh7HDN4PlgSo1z1RJ0j9QYIS7st7ob4L+C5wpCPoBRA2ccFf2BQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:45:26Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327126"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984467"},"operations":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192370561220608"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192370561220608"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"}},"id":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","paging_token":"120192370561220608","successful":true,"hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","ledger":27984467,"created_at":"2020-01-29T19:44:36Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911491","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAADAAAAAQAAAAAAAAAAAAAAAF4x4PoAAAAAAAAAAQAAAAAAAAABAAAAADDlrXRGScHlgQ6yFRg0DlaHYp65V238wX6rkewBbcVuAAAAAAAAAAB3NZQAAAAAAAAAAAGXebqxAAAAQMzdIubro9XQUTkhf0YbDBNM5tqC/zS7fGb0BLFq+QxXT7VAS7dDMno9A2f1df4nnyeHqVl+CuKcpwwwS04JSgE=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAB4ZsEAAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["zN0i5uuj1dBROSF/RhsME0zm2oL/NLt8ZvQEsWr5DFdPtUBLt0Myej0DZ/V1/iefJ4epWX4K4pynDDBLTglKAQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:46:02Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327162"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000615"},"operations":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261725693136896"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261725693136896"},"transaction":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"}},"id":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","paging_token":"120261725693136896","successful":true,"hash":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","ledger":28000615,"created_at":"2020-01-30T21:45:07Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911492","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAEAAAAAQAAAAAAAAAAAAAAAF4zTrgAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAF9eEAAAAAAAAAAAGXebqxAAAAQB9XBu17Olvry7c8CqLJXqvK5csy2r3lGiP3HyR5JcryL8QQjSuwGr/LEFFKIS5Afo/jh9fCzGzJzZQ4DN1KPgs=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0EQAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAACYljUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["H1cG7Xs6W+vLtzwKosleq8rlyzLaveUaI/cfJHklyvIvxBCNK7Aav8sQUUohLkB+j+OH18LMbMnNlDgM3Uo+Cw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:32Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420792"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000619"},"operations":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261742872928256"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261742872928256"},"transaction":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"}},"id":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","paging_token":"120261742872928256","successful":true,"hash":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","ledger":28000619,"created_at":"2020-01-30T21:45:29Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911493","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAFAAAAAQAAAAAAAAAAAAAAAF4zTtEAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAO5rKAAAAAAAAAAAGXebqxAAAAQFaUIoWWXLurZRFty6iBHmm65K2w5EZjldQcMsB/KeQl1Rh0UkZ7Q44JCDCvntnIhWfkl1Qipr6jZk/I4c+pjw8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAXPuxUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["VpQihZZcu6tlEW3LqIEeabrkrbDkRmOV1BwywH8p5CXVGHRSRntDjgkIMK+e2ciFZ+SXVCKmvqNmT8jhz6mPDw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:57Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420817"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28210091"},"operations":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121161418262413312"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121161418262413312"},"transaction":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"}},"id":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","paging_token":"121161418262413312","successful":true,"hash":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","ledger":28210091,"created_at":"2020-02-13T18:54:50Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911494","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAGAAAAAQAAAAAAAAAAAAAAAF5Fm9EAAAAAAAAAAQAAAAAAAAAAAAAAADKjrtXFaprjtdoV8mYex4557fEGVYkp83K0vfUwEyVnAAAAAAvrwgAAAAAAAAAAAZd5urEAAABAKCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA==","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnOrAAAAAAAAAAAyo67VxWqa47XaFfJmHseOee3xBlWJKfNytL31MBMlZwAAAAAL68IAAa5zqwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["KCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T18:56:17Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581620177"}}},{"memo":"hello world","memo_bytes":"aGVsbG8gd29ybGQ=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28211677"},"operations":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121168230080335872"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121168230080335872"},"transaction":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"}},"id":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","paging_token":"121168230080335872","successful":true,"hash":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","ledger":28211677,"created_at":"2020-02-13T21:21:01Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911495","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAHAAAAAQAAAAAAAAAAAAAAAF5Fvg4AAAABAAAAC2hlbGxvIHdvcmxkAAAAAAEAAAAAAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAAAAAAAAAAGXebqxAAAAQPNJSRhqEmEaKqtigW3PTPmm0SPF2befw+hH+j7hhDW9L7xDA6FDZlEvFESKAQxWBMQeV9r3D/7Y8tx5uW2WwQk=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAHAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnndAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAa553QAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["80lJGGoSYRoqq2KBbc9M+abRI8XZt5/D6Ef6PuGENb0vvEMDoUNmUS8URIoBDFYExB5X2vcP/tjy3Hm5bZbBCQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T21:22:22Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581628942"}}},{"memo":"Airdrop invite✅xlmget.org","memo_bytes":"QWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3Jn","_links":{"self":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"},"account":{"href":"https://horizon.stellar.org/accounts/GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28440958"},"operations":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=122152984477229056"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=122152984477229056"},"transaction":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"}},"id":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","paging_token":"122152984477229056","successful":true,"hash":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","ledger":28440958,"created_at":"2020-02-28T16:28:42Z","source_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","source_account_sequence":"122138905574114388","fee_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGNu3LLrwNqG1XHvOPh+VluxEUDSURdHrY4gw8+q98O5AAAAZAGx7LAAAARUAAAAAAAAAAEAAAAbQWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3JnAAAAAAEAAAAAAAAAAQAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAAAAAAAAGGoAAAAAAAAAABqvfDuQAAAECzK8e8L+dHqGZWsoOwNLgTnFD+Omu3DcVJ4Gwb71ZKsokaH+2hPLf65I6GgIX4pcyz1SgRNuhi0Utg4tGkfGUA","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARTAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARUAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8ebkAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYYjSwAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBsfl8AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7u0AbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["syvHvC/nR6hmVrKDsDS4E5xQ/jprtw3FSeBsG+9WSrKJGh/toTy3+uSOhoCF+KXMs9UoETboYtFLYOLRpHxlAA=="]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Transactions","description":{"content":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"GetTransactionsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"RetrieveAnAccountsTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=122152984477229056&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=94658837230923776&limit=10&order=desc"}},"_embedded":{"records":[{"memo":"","memo_bytes":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"},"account":{"href":"https://horizon.stellar.org/accounts/GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR"},"ledger":{"href":"https://horizon.stellar.org/ledgers/22039478"},"operations":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=94658837230923776"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=94658837230923776"},"transaction":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"}},"id":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","paging_token":"94658837230923776","successful":true,"hash":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","ledger":22039478,"created_at":"2019-01-18T14:40:47Z","source_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","source_account_sequence":"90296735301107721","fee_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAHEnAZ8fNRZRvFiUIuG3zTZfzTVQ9NZH39J5v+giP4ZOAAAAZAFAzGcAAAAJAAAAAQAAAAAAAAAAAAAAAFxB5cMAAAABAAAAAAAAAAEAAAAAAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAAAAAAAAAAEiP4ZOAAAAQO421wcb/JYfBpnYEJzHpMyQnrM8rHd4PUoyHXpPlvQAUGzARqwbX8hcLSM4tlk51AwbuZOaZfWCaFQfzFZJuAA=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAIAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAJAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAg2BPkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBUCemAAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wTIAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["7jbXBxv8lh8GmdgQnMekzJCeszysd3g9SjIdek+W9ABQbMBGrBtfyFwtIzi2WTnUDBu5k5pl9YJoVB/MVkm4AA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-01-18T14:42:11Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1547822531"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"},"account":{"href":"https://horizon.stellar.org/accounts/GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX"},"ledger":{"href":"https://horizon.stellar.org/ledgers/23895910"},"operations":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=102632151958179840"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=102632151958179840"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"}},"id":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","paging_token":"102632151958179840","successful":true,"hash":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","ledger":23895910,"created_at":"2019-05-17T14:43:53Z","source_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","source_account_sequence":"93143259236270083","fee_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAABftGINkC2jBebpVPlixLNCnvmLQFyHztWK/mlM1De1rAAAAZAFK6U0AAAADAAAAAQAAAAAAAAAAAAAAAFzeydEAAAAAAAAAAQAAAAAAAAABAAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAAAAAAALLQXgAAAAAAAAAAAE1De1rAAAAQLFFYK9rGA2Um2Vwguj4Ra3T6gaeturf4Qw/0LcG/qa/oXZeu6s7ZrB3wVVJu0m123Z7zirYoo576IS8agzLKQQ=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAAAKupPUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBS+8PAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/Aw4AUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["sUVgr2sYDZSbZXCC6PhFrdPqBp626t/hDD/Qtwb+pr+hdl67qztmsHfBVUm7SbXbdnvOKtiijnvohLxqDMspBA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-05-17T14:48:49Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1558104529"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27114571"},"operations":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=116456195690164224"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=116456195690164224"},"transaction":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"}},"id":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","paging_token":"116456195690164224","successful":true,"hash":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","ledger":27114571,"created_at":"2019-12-04T22:03:41Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911489","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAABAAAAAQAAAAAAAAAAAAAAAF3oLZMAAAAAAAAAAQAAAAAAAAABAAAAAARD8QZr6wa97ii5JeeuMJEXycVsEO1dBekjRTcI9AadAAAAAAAAAAABMS0AAAAAAAAAAAGXebqxAAAAQND+muz3883MoHmTtuhsDb4awF1U3EDJ2FQn8Ia2C9L+Rz62Z9EvH8rl81d3oPxrjUnedZmjOnptn6Agm5alHwc=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBnbwPAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAABxZQNiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAAByljBiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["0P6a7PfzzcygeZO26GwNvhrAXVTcQMnYVCfwhrYL0v5HPrZn0S8fyuXzV3eg/GuNSd51maM6em2foCCblqUfBw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-12-04T22:05:07Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1575497107"}}},{"memo":"hello universe","memo_bytes":"aGVsbG8gdW5pdmVyc2U=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984461"},"operations":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192344791343104"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192344791343104"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"}},"id":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","paging_token":"120192344791343104","successful":true,"hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","ledger":27984461,"created_at":"2020-01-29T19:43:59Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911490","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAACAAAAAQAAAAAAAAAAAAAAAF4x4NYAAAABAAAADmhlbGxvIHVuaXZlcnNlAAAAAAABAAAAAAAAAAAAAAAAMOWtdEZJweWBDrIVGDQOVodinrlXbfzBfquR7AFtxW4AAAAAATEtAAAAAAAAAAABl3m6sQAAAEDwdDlpQv5IfweTkLjytpWIa+bpQv7BAHRFpMCHscM3g+WBKjXPVEnSP1BghLuy3uhvgv4LnCkI+gFEDZxwV/YF","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["8HQ5aUL+SH8Hk5C48raViGvm6UL+wQB0RaTAh7HDN4PlgSo1z1RJ0j9QYIS7st7ob4L+C5wpCPoBRA2ccFf2BQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:45:26Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327126"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984467"},"operations":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192370561220608"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192370561220608"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"}},"id":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","paging_token":"120192370561220608","successful":true,"hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","ledger":27984467,"created_at":"2020-01-29T19:44:36Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911491","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAADAAAAAQAAAAAAAAAAAAAAAF4x4PoAAAAAAAAAAQAAAAAAAAABAAAAADDlrXRGScHlgQ6yFRg0DlaHYp65V238wX6rkewBbcVuAAAAAAAAAAB3NZQAAAAAAAAAAAGXebqxAAAAQMzdIubro9XQUTkhf0YbDBNM5tqC/zS7fGb0BLFq+QxXT7VAS7dDMno9A2f1df4nnyeHqVl+CuKcpwwwS04JSgE=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAB4ZsEAAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["zN0i5uuj1dBROSF/RhsME0zm2oL/NLt8ZvQEsWr5DFdPtUBLt0Myej0DZ/V1/iefJ4epWX4K4pynDDBLTglKAQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:46:02Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327162"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000615"},"operations":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261725693136896"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261725693136896"},"transaction":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"}},"id":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","paging_token":"120261725693136896","successful":true,"hash":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","ledger":28000615,"created_at":"2020-01-30T21:45:07Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911492","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAEAAAAAQAAAAAAAAAAAAAAAF4zTrgAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAF9eEAAAAAAAAAAAGXebqxAAAAQB9XBu17Olvry7c8CqLJXqvK5csy2r3lGiP3HyR5JcryL8QQjSuwGr/LEFFKIS5Afo/jh9fCzGzJzZQ4DN1KPgs=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0EQAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAACYljUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["H1cG7Xs6W+vLtzwKosleq8rlyzLaveUaI/cfJHklyvIvxBCNK7Aav8sQUUohLkB+j+OH18LMbMnNlDgM3Uo+Cw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:32Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420792"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000619"},"operations":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261742872928256"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261742872928256"},"transaction":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"}},"id":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","paging_token":"120261742872928256","successful":true,"hash":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","ledger":28000619,"created_at":"2020-01-30T21:45:29Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911493","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAFAAAAAQAAAAAAAAAAAAAAAF4zTtEAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAO5rKAAAAAAAAAAAGXebqxAAAAQFaUIoWWXLurZRFty6iBHmm65K2w5EZjldQcMsB/KeQl1Rh0UkZ7Q44JCDCvntnIhWfkl1Qipr6jZk/I4c+pjw8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAXPuxUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["VpQihZZcu6tlEW3LqIEeabrkrbDkRmOV1BwywH8p5CXVGHRSRntDjgkIMK+e2ciFZ+SXVCKmvqNmT8jhz6mPDw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:57Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420817"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28210091"},"operations":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121161418262413312"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121161418262413312"},"transaction":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"}},"id":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","paging_token":"121161418262413312","successful":true,"hash":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","ledger":28210091,"created_at":"2020-02-13T18:54:50Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911494","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAGAAAAAQAAAAAAAAAAAAAAAF5Fm9EAAAAAAAAAAQAAAAAAAAAAAAAAADKjrtXFaprjtdoV8mYex4557fEGVYkp83K0vfUwEyVnAAAAAAvrwgAAAAAAAAAAAZd5urEAAABAKCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA==","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnOrAAAAAAAAAAAyo67VxWqa47XaFfJmHseOee3xBlWJKfNytL31MBMlZwAAAAAL68IAAa5zqwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["KCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T18:56:17Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581620177"}}},{"memo":"hello world","memo_bytes":"aGVsbG8gd29ybGQ=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28211677"},"operations":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121168230080335872"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121168230080335872"},"transaction":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"}},"id":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","paging_token":"121168230080335872","successful":true,"hash":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","ledger":28211677,"created_at":"2020-02-13T21:21:01Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911495","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAHAAAAAQAAAAAAAAAAAAAAAF5Fvg4AAAABAAAAC2hlbGxvIHdvcmxkAAAAAAEAAAAAAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAAAAAAAAAAGXebqxAAAAQPNJSRhqEmEaKqtigW3PTPmm0SPF2befw+hH+j7hhDW9L7xDA6FDZlEvFESKAQxWBMQeV9r3D/7Y8tx5uW2WwQk=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAHAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnndAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAa553QAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["80lJGGoSYRoqq2KBbc9M+abRI8XZt5/D6Ef6PuGENb0vvEMDoUNmUS8URIoBDFYExB5X2vcP/tjy3Hm5bZbBCQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T21:22:22Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581628942"}}},{"memo":"Airdrop invite✅xlmget.org","memo_bytes":"QWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3Jn","_links":{"self":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"},"account":{"href":"https://horizon.stellar.org/accounts/GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28440958"},"operations":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=122152984477229056"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=122152984477229056"},"transaction":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"}},"id":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","paging_token":"122152984477229056","successful":true,"hash":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","ledger":28440958,"created_at":"2020-02-28T16:28:42Z","source_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","source_account_sequence":"122138905574114388","fee_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGNu3LLrwNqG1XHvOPh+VluxEUDSURdHrY4gw8+q98O5AAAAZAGx7LAAAARUAAAAAAAAAAEAAAAbQWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3JnAAAAAAEAAAAAAAAAAQAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAAAAAAAAGGoAAAAAAAAAABqvfDuQAAAECzK8e8L+dHqGZWsoOwNLgTnFD+Omu3DcVJ4Gwb71ZKsokaH+2hPLf65I6GgIX4pcyz1SgRNuhi0Utg4tGkfGUA","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARTAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARUAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8ebkAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYYjSwAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBsfl8AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7u0AbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["syvHvC/nR6hmVrKDsDS4E5xQ/jprtw3FSeBsG+9WSrKJGh/toTy3+uSOhoCF+KXMs9UoETboYtFLYOLRpHxlAA=="]}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Transactions","description":{"content":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-accounts.api.mdx b/api/horizon/resources/list-all-accounts.api.mdx index e1a64bd14..49bdca03d 100644 --- a/api/horizon/resources/list-all-accounts.api.mdx +++ b/api/horizon/resources/list-all-accounts.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists accounts by one of four filters : signer, asse sidebar_label: "List all Accounts" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","operationId":"ListAllAccounts","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"asset","in":"query","required":false,"description":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset."},{"name":"signer","in":"query","required":false,"description":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"liqudity_pool","in":"query","required":false,"description":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Returns accounts based on provided filter: signer , asset, sponser or liquidity pool","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offers":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"trades":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"data":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","payments","effects","offers","trades","data"]},"id":{"type":"string","title":"id"},"account_id":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"sequence":{"type":"string","pattern":"[0-9]+","title":"sequence"},"sequence_ledger":{"type":"integer","format":"uint32","title":"sequence_ledger"},"sequence_time":{"type":"string"},"subentry_count":{"type":"integer","format":"int32","title":"subentry_count"},"inflation_destination":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"home_domain":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"thresholds":{"type":"object","properties":{"low_threshold":{"type":"integer"},"med_threshold":{"type":"integer"},"high_threshold":{"type":"integer"}},"title":"thresholds"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"},"auth_clawback_enabled":{"type":"boolean"}},"title":"flags"},"balances":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"liquidity_pool_id":{"type":"string"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native"]}},"required":["balance","limit","asset_type","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineNative"},{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["balance","limit","asset_type","asset_code","asset_issuer","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineAsset"},{"type":"object","properties":{"liquidity_pool_id":{"type":"string"},"asset_type":{"type":"string","enum":["liquidity_pool_shares"]},"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"}},"required":["liquidity_pool_id","balance","limit","asset_type","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineLiquidityPool"}]}},"signers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"weight":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["ed25519_public_key","sha256_hash","preauth_tx"]},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["key","weight","type"],"title":"signers"}},"data":{"type":"object"},"num_sponsoring":{"type":"integer"},"num_sponsered":{"type":"integer"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"}},"required":["id","account_id","sequence","subentry_count","last_modified_ledger","last_modified_time","thresholds","flags","balances","signers","data","num_sponsoring","num_sponsered","paging_token"]}}}}},"title":"Account"}]},"examples":{"ListAllAccounts":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts?cursor=&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"next":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"prev":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=desc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"transactions":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/operations{?cursor,limit,order}","templated":true},"payments":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/payments{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/effects{?cursor,limit,order}","templated":true},"offers":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/offers{?cursor,limit,order}","templated":true},"trades":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/trades{?cursor,limit,order}","templated":true},"data":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/data/{key}","templated":true}},"id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","account_id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","sequence":"24739097524306474","subentry_count":3,"inflation_destination":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","home_domain":"tempo.eu.com","last_modified_ledger":40074676,"last_modified_time":"2022-03-17T23:13:54Z","thresholds":{"low_threshold":5,"med_threshold":0,"high_threshold":0},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":false},"balances":[{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":40074670,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":20213845,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"NGN","asset_issuer":"GCC4YLCR7DDWFCIPTROQM7EB2QMFD35XRWEQVIQYJQHVW6VE5MJZXIGW"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":7877447,"is_authorized":false,"is_authorized_to_maintain_liabilities":false,"asset_type":"credit_alphanum4","asset_code":"PHP","asset_issuer":"GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"},{"balance":"80.8944518","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","asset_type":"native"}],"signers":[{"weight":10,"key":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","type":"ed25519_public_key"}],"data":{},"num_sponsoring":0,"num_sponsored":0,"paging_token":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Accounts","description":{"content":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset.","type":"text/plain"},"key":"asset","value":""},{"disabled":false,"description":{"content":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","type":"text/plain"},"key":"signer","value":""},{"description":{"content":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool.","type":"text/plain"},"key":"liqudity_pool","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","operationId":"ListAllAccounts","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"asset","in":"query","required":false,"description":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset."},{"name":"signer","in":"query","required":false,"description":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"liqudity_pool","in":"query","required":false,"description":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Returns accounts based on provided filter: signer , asset, sponser or liquidity pool","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offers":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"trades":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"data":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","payments","effects","offers","trades","data"]},"id":{"type":"string","title":"id"},"account_id":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"sequence":{"type":"string","pattern":"[0-9]+","title":"sequence"},"sequence_ledger":{"type":"integer","format":"uint32","title":"sequence_ledger"},"sequence_time":{"type":"string"},"subentry_count":{"type":"integer","format":"int32","title":"subentry_count"},"inflation_destination":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"home_domain":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"thresholds":{"type":"object","properties":{"low_threshold":{"type":"integer"},"med_threshold":{"type":"integer"},"high_threshold":{"type":"integer"}},"title":"thresholds"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"},"auth_clawback_enabled":{"type":"boolean"}},"title":"flags"},"balances":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"liquidity_pool_id":{"type":"string"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native"]}},"required":["balance","limit","asset_type","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineNative"},{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["balance","limit","asset_type","asset_code","asset_issuer","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineAsset"},{"type":"object","properties":{"liquidity_pool_id":{"type":"string"},"asset_type":{"type":"string","enum":["liquidity_pool_shares"]},"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"}},"required":["liquidity_pool_id","balance","limit","asset_type","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineLiquidityPool"}]}},"signers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"weight":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["ed25519_public_key","sha256_hash","preauth_tx"]},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["key","weight","type"],"title":"signers"}},"data":{"type":"object"},"num_sponsoring":{"type":"integer"},"num_sponsered":{"type":"integer"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"}},"required":["id","account_id","sequence","subentry_count","last_modified_ledger","last_modified_time","thresholds","flags","balances","signers","data","num_sponsoring","num_sponsered","paging_token"]}}}}},"title":"Account"}]},"examples":{"ListAllAccounts":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts?cursor=&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"next":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"prev":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=desc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"transactions":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/operations{?cursor,limit,order}","templated":true},"payments":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/payments{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/effects{?cursor,limit,order}","templated":true},"offers":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/offers{?cursor,limit,order}","templated":true},"trades":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/trades{?cursor,limit,order}","templated":true},"data":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/data/{key}","templated":true}},"id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","account_id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","sequence":"24739097524306474","subentry_count":3,"inflation_destination":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","home_domain":"tempo.eu.com","last_modified_ledger":40074676,"last_modified_time":"2022-03-17T23:13:54Z","thresholds":{"low_threshold":5,"med_threshold":0,"high_threshold":0},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":false},"balances":[{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":40074670,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":20213845,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"NGN","asset_issuer":"GCC4YLCR7DDWFCIPTROQM7EB2QMFD35XRWEQVIQYJQHVW6VE5MJZXIGW"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":7877447,"is_authorized":false,"is_authorized_to_maintain_liabilities":false,"asset_type":"credit_alphanum4","asset_code":"PHP","asset_issuer":"GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"},{"balance":"80.8944518","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","asset_type":"native"}],"signers":[{"weight":10,"key":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","type":"ed25519_public_key"}],"data":{},"num_sponsoring":0,"num_sponsored":0,"paging_token":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}]}}}}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Accounts","description":{"content":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset.","type":"text/plain"},"key":"asset","value":""},{"disabled":false,"description":{"content":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","type":"text/plain"},"key":"signer","value":""},{"description":{"content":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool.","type":"text/plain"},"key":"liqudity_pool","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-assets.api.mdx b/api/horizon/resources/list-all-assets.api.mdx index 73e8b83d9..995464b97 100644 --- a/api/horizon/resources/list-all-assets.api.mdx +++ b/api/horizon/resources/list-all-assets.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all assets." sidebar_label: "List all Assets" hide_title: true hide_table_of_contents: true -api: {"tags":["Assets"],"description":"This endpoint lists all assets.","operationId":"ListAllAssets","parameters":[{"name":"asset_code","in":"query","required":false,"description":"The code of the asset you would like to filter by."},{"name":"asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer for the asset you would like to filter by."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"toml":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"asset_type":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"},"accounts":{"type":"object","properties":{"authorized":{"type":"integer"},"authorized_to_maintain_liabilities":{"type":"integer"},"unauthorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"num_contracts":{"type":"integer"},"num_liquidity_pools":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unauthorized":{"type":"string"}}},"claimable_balances_amount":{"type":"string"},"contracts_amount":{"type":"string"},"liquidity_pools_amount":{"type":"string"},"amount":{"type":"string"},"num_accounts":{"type":"integer"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"}}}}}}}}},"title":"Asset"}]},"examples":{"ListAllAssets":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"toml":{"href":"https://swisscustodys.org/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A","paging_token":"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4","num_accounts":10,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"899996000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}},{"_links":{"toml":{"href":"https://StellarAssets.org/fx/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N","paging_token":"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4","num_accounts":43,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"1.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":true}},{"_links":{"toml":{"href":"https://masterstellar.com/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I","paging_token":"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4","num_accounts":1,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"65000000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/assets","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Assets","description":{"content":"This endpoint lists all assets.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The code of the asset you would like to filter by.","type":"text/plain"},"key":"asset_code","value":""},{"description":{"content":"The Stellar address of the issuer for the asset you would like to filter by.","type":"text/plain"},"key":"asset_issuer","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Assets"],"description":"This endpoint lists all assets.","operationId":"ListAllAssets","parameters":[{"name":"asset_code","in":"query","required":false,"description":"The code of the asset you would like to filter by."},{"name":"asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer for the asset you would like to filter by."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"toml":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"asset_type":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"},"accounts":{"type":"object","properties":{"authorized":{"type":"integer"},"authorized_to_maintain_liabilities":{"type":"integer"},"unauthorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"num_contracts":{"type":"integer"},"num_liquidity_pools":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unauthorized":{"type":"string"}}},"claimable_balances_amount":{"type":"string"},"contracts_amount":{"type":"string"},"liquidity_pools_amount":{"type":"string"},"amount":{"type":"string"},"num_accounts":{"type":"integer"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"}}}}}}}}},"title":"Asset"}]},"examples":{"ListAllAssets":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"toml":{"href":"https://swisscustodys.org/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A","paging_token":"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4","num_accounts":10,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"899996000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}},{"_links":{"toml":{"href":"https://StellarAssets.org/fx/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N","paging_token":"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4","num_accounts":43,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"1.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":true}},{"_links":{"toml":{"href":"https://masterstellar.com/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I","paging_token":"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4","num_accounts":1,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"65000000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}}]}}}}}}}},"method":"get","path":"/assets","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Assets","description":{"content":"This endpoint lists all assets.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The code of the asset you would like to filter by.","type":"text/plain"},"key":"asset_code","value":""},{"description":{"content":"The Stellar address of the issuer for the asset you would like to filter by.","type":"text/plain"},"key":"asset_issuer","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-effects.api.mdx b/api/horizon/resources/list-all-effects.api.mdx index 345968977..d78feff70 100644 --- a/api/horizon/resources/list-all-effects.api.mdx +++ b/api/horizon/resources/list-all-effects.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all effects and can be used in streaming mode. sidebar_label: "List All Effects" hide_title: true hide_table_of_contents: true -api: {"tags":["Effects"],"description":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"ListAllEffects","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["Account Created","Account Removed","Account Credited","Account Debited","Account Thresholds Updated","Account Home Domain Updated","Account Flags Updated","Account Inflation Destination Updated","Signer Created","Signer Removed","Signer Updated","Trustline Created","Trustline Removed","Trustline Updated","Trustline Authorized","Trustline Deauthorized","Offer Created","Offer Removed","Offer Updated","Trade","Data Created","Data Removed","Data Updated","Claimable Balance Created","Claimable Balance Claimant Created","Claimable Balance Claimed","Account Sponsorship Created","Account Sponsorship Updated","Account Sponsorship Removed","Trustline Sponsorship Created","Trustline Sponsorship Updated","Trustline Sponsorship Removed","Account Data Sponsorship Created","Account Data Sponsorship Updated","Account Data Sponsorship Removed","Claimable Balance Sponsorship Created","Claimable Balance Sponsorship Updated","Claimable Balance Sponsorship Removed","Account Signer Sponsorship Created","Account Signer Sponsorship Updated","Account Signer Sponsorship Removed","Liquidity Pool Created","Liquidity Pool Removed","Liquidity Pool Revoked","Liquidity Pool Deposited","Liquidity Pool Withdraw","Liquidity Pool Trade","Sequence Bumped"]},"type_i":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"ListAllEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/effects?cursor=33676838572034-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/effects?cursor=12884905985-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-1"}},"id":"0000000012884905985-0000000001","paging_token":"12884905985-1","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_created","type_i":0,"created_at":"2015-09-30T17:15:54Z","starting_balance":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-2"}},"id":"0000000012884905985-0000000002","paging_token":"12884905985-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"account_debited","type_i":3,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-3"}},"id":"0000000012884905985-0000000003","paging_token":"12884905985-3","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"signer_created","type_i":10,"created_at":"2015-09-30T17:15:54Z","weight":1,"public_key":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-1","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_credited","type_i":2,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-2"}},"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"account_debited","type_i":3,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905987"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987-1"}},"id":"0000000012884905987-0000000001","paging_token":"12884905987-1","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"signer_removed","type_i":11,"created_at":"2015-09-30T17:15:54Z","weight":0,"public_key":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-1"}},"id":"0000033676838572033-0000000001","paging_token":"33676838572033-1","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-2"}},"id":"0000033676838572033-0000000002","paging_token":"33676838572033-2","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_debited","type_i":3,"created_at":"2015-10-01T04:15:01Z","asset_type":"native","amount":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-3"}},"id":"0000033676838572033-0000000003","paging_token":"33676838572033-3","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"signer_created","type_i":10,"created_at":"2015-10-01T04:15:01Z","weight":1,"public_key":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572034"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572034-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572034-1"}},"id":"0000033676838572034-0000000001","paging_token":"33676838572034-1","account":"GCZTBYH66ISTZKUPVJWTMHWBH4S4JIJ7WNLQJXCTQJKWY3FIT34BWZCJ","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Effects","description":{"content":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Effects"],"description":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"ListAllEffects","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["Account Created","Account Removed","Account Credited","Account Debited","Account Thresholds Updated","Account Home Domain Updated","Account Flags Updated","Account Inflation Destination Updated","Signer Created","Signer Removed","Signer Updated","Trustline Created","Trustline Removed","Trustline Updated","Trustline Authorized","Trustline Deauthorized","Offer Created","Offer Removed","Offer Updated","Trade","Data Created","Data Removed","Data Updated","Claimable Balance Created","Claimable Balance Claimant Created","Claimable Balance Claimed","Account Sponsorship Created","Account Sponsorship Updated","Account Sponsorship Removed","Trustline Sponsorship Created","Trustline Sponsorship Updated","Trustline Sponsorship Removed","Account Data Sponsorship Created","Account Data Sponsorship Updated","Account Data Sponsorship Removed","Claimable Balance Sponsorship Created","Claimable Balance Sponsorship Updated","Claimable Balance Sponsorship Removed","Account Signer Sponsorship Created","Account Signer Sponsorship Updated","Account Signer Sponsorship Removed","Liquidity Pool Created","Liquidity Pool Removed","Liquidity Pool Revoked","Liquidity Pool Deposited","Liquidity Pool Withdraw","Liquidity Pool Trade","Sequence Bumped"]},"type_i":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"ListAllEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/effects?cursor=33676838572034-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/effects?cursor=12884905985-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-1"}},"id":"0000000012884905985-0000000001","paging_token":"12884905985-1","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_created","type_i":0,"created_at":"2015-09-30T17:15:54Z","starting_balance":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-2"}},"id":"0000000012884905985-0000000002","paging_token":"12884905985-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"account_debited","type_i":3,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-3"}},"id":"0000000012884905985-0000000003","paging_token":"12884905985-3","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"signer_created","type_i":10,"created_at":"2015-09-30T17:15:54Z","weight":1,"public_key":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-1","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_credited","type_i":2,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-2"}},"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"account_debited","type_i":3,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905987"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987-1"}},"id":"0000000012884905987-0000000001","paging_token":"12884905987-1","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"signer_removed","type_i":11,"created_at":"2015-09-30T17:15:54Z","weight":0,"public_key":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-1"}},"id":"0000033676838572033-0000000001","paging_token":"33676838572033-1","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-2"}},"id":"0000033676838572033-0000000002","paging_token":"33676838572033-2","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_debited","type_i":3,"created_at":"2015-10-01T04:15:01Z","asset_type":"native","amount":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-3"}},"id":"0000033676838572033-0000000003","paging_token":"33676838572033-3","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"signer_created","type_i":10,"created_at":"2015-10-01T04:15:01Z","weight":1,"public_key":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572034"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572034-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572034-1"}},"id":"0000033676838572034-0000000001","paging_token":"33676838572034-1","account":"GCZTBYH66ISTZKUPVJWTMHWBH4S4JIJ7WNLQJXCTQJKWY3FIT34BWZCJ","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"}]}}}}}}}},"method":"get","path":"/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Effects","description":{"content":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-ledgers.api.mdx b/api/horizon/resources/list-all-ledgers.api.mdx index 9a70d460b..312183b21 100644 --- a/api/horizon/resources/list-all-ledgers.api.mdx +++ b/api/horizon/resources/list-all-ledgers.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all ledgers and can be used in streaming mode. sidebar_label: "List All Ledgers" hide_title: true hide_table_of_contents: true -api: {"tags":["Ledgers"],"description":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","operationId":"ListAllLedgers","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","effects"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"hash":{"type":"string","title":"hash"},"pre_hash":{"type":"string","title":"hash"},"sequence":{"type":"integer","format":"int32"},"successful_transaction_count":{"type":"integer","format":"int32"},"failed_transaction_count":{"type":"integer","format":"int32"},"operation_count":{"type":"integer","format":"int32"},"tx_set_operation_count":{"type":"integer","format":"int32"},"closed_at":{"type":"string"},"total_coins":{"type":"string"},"fee_pool":{"type":"string"},"base_fee_in_stroops":{"type":"integer","format":"int32"},"base_reserve_in_stroops":{"type":"integer","format":"int32"},"max_tx_set_size":{"type":"integer","format":"int32"},"protocol_version":{"type":"integer","format":"int32"},"header_xdr":{"type":"string"}}}}},"required":["id","paging_token","hash","sequence","successful_transaction_count","failed_transaction_count","operation_count","tx_set_operation_count","closed_at","total_coins","fee_pool","base_fee_in_stroops","base_reserve_in_stroops","max_tx_set_size","protocol_version","header_xdr"]}},"title":"Ledger"},"examples":{"ListAllLedgers":{"value":{"_embedded":{"records":[{"_links":{"effects":{"href":"/ledgers/1/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/1/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/1"},"transactions":{"href":"/ledgers/1/transactions/{?cursor,limit,order}","templated":true}},"id":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","paging_token":"4294967296","hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":1,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"tx_set_operation_count":0,"closed_at":"1970-01-01T00:00:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":50},{"_links":{"effects":{"href":"/ledgers/2/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/2/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/2"},"transactions":{"href":"/ledgers/2/transactions/{?cursor,limit,order}","templated":true}},"id":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","paging_token":"8589934592","hash":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","prev_hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":2,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"closed_at":"2015-07-16T23:49:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":100}]},"_links":{"next":{"href":"/ledgers?order=asc&limit=2&cursor=8589934592"},"prev":{"href":"/ledgers?order=desc&limit=2&cursor=4294967296"},"self":{"href":"/ledgers?order=asc&limit=2&cursor="}}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/ledgers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Ledgers","description":{"content":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","type":"text/plain"},"url":{"path":["ledgers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Ledgers"],"description":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","operationId":"ListAllLedgers","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","effects"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"hash":{"type":"string","title":"hash"},"pre_hash":{"type":"string","title":"hash"},"sequence":{"type":"integer","format":"int32"},"successful_transaction_count":{"type":"integer","format":"int32"},"failed_transaction_count":{"type":"integer","format":"int32"},"operation_count":{"type":"integer","format":"int32"},"tx_set_operation_count":{"type":"integer","format":"int32"},"closed_at":{"type":"string"},"total_coins":{"type":"string"},"fee_pool":{"type":"string"},"base_fee_in_stroops":{"type":"integer","format":"int32"},"base_reserve_in_stroops":{"type":"integer","format":"int32"},"max_tx_set_size":{"type":"integer","format":"int32"},"protocol_version":{"type":"integer","format":"int32"},"header_xdr":{"type":"string"}}}}},"required":["id","paging_token","hash","sequence","successful_transaction_count","failed_transaction_count","operation_count","tx_set_operation_count","closed_at","total_coins","fee_pool","base_fee_in_stroops","base_reserve_in_stroops","max_tx_set_size","protocol_version","header_xdr"]}},"title":"Ledger"},"examples":{"ListAllLedgers":{"value":{"_embedded":{"records":[{"_links":{"effects":{"href":"/ledgers/1/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/1/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/1"},"transactions":{"href":"/ledgers/1/transactions/{?cursor,limit,order}","templated":true}},"id":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","paging_token":"4294967296","hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":1,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"tx_set_operation_count":0,"closed_at":"1970-01-01T00:00:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":50},{"_links":{"effects":{"href":"/ledgers/2/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/2/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/2"},"transactions":{"href":"/ledgers/2/transactions/{?cursor,limit,order}","templated":true}},"id":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","paging_token":"8589934592","hash":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","prev_hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":2,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"closed_at":"2015-07-16T23:49:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":100}]},"_links":{"next":{"href":"/ledgers?order=asc&limit=2&cursor=8589934592"},"prev":{"href":"/ledgers?order=desc&limit=2&cursor=4294967296"},"self":{"href":"/ledgers?order=asc&limit=2&cursor="}}}}}}}}},"method":"get","path":"/ledgers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Ledgers","description":{"content":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","type":"text/plain"},"url":{"path":["ledgers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-operations.api.mdx b/api/horizon/resources/list-all-operations.api.mdx index 2d0bd1db2..a2628b821 100644 --- a/api/horizon/resources/list-all-operations.api.mdx +++ b/api/horizon/resources/list-all-operations.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful operations and can be used in s sidebar_label: "List All Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Operations"],"description":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"ListAllOperations","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"ListAllOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/operations?cursor=12884905987&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/operations?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905987"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905987/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987"}},"id":"12884905987","paging_token":"12884905987","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"set_options","type_i":5,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","master_key_weight":0}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Operations","description":{"content":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Operations"],"description":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"ListAllOperations","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"ListAllOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/operations?cursor=12884905987&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/operations?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905987"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905987/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987"}},"id":"12884905987","paging_token":"12884905987","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"set_options","type_i":5,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","master_key_weight":0}]}}}}}}}},"method":"get","path":"/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Operations","description":{"content":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-payments.api.mdx b/api/horizon/resources/list-all-payments.api.mdx index dd5b6566c..6a0597a1f 100644 --- a/api/horizon/resources/list-all-payments.api.mdx +++ b/api/horizon/resources/list-all-payments.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful payment-related operations and sidebar_label: "List All Payments" hide_title: true hide_table_of_contents: true -api: {"tags":["Operations"],"description":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","operationId":"ListAllPayments","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"ListAllPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/payments?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/payments?cursor=33676838572033&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/payments?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/33676838572033"},"transaction":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"effects":{"href":"https://horizon.stellar.org/operations/33676838572033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033"}},"id":"33676838572033","paging_token":"33676838572033","transaction_successful":true,"source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"create_account","type_i":0,"created_at":"2015-10-01T04:15:01Z","transaction_hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","starting_balance":"20.0000000","funder":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Payments","description":{"content":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Operations"],"description":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","operationId":"ListAllPayments","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"ListAllPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/payments?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/payments?cursor=33676838572033&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/payments?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/33676838572033"},"transaction":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"effects":{"href":"https://horizon.stellar.org/operations/33676838572033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033"}},"id":"33676838572033","paging_token":"33676838572033","transaction_successful":true,"source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"create_account","type_i":0,"created_at":"2015-10-01T04:15:01Z","transaction_hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","starting_balance":"20.0000000","funder":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4"}]}}}}}}}},"method":"get","path":"/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Payments","description":{"content":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-transactions.api.mdx b/api/horizon/resources/list-all-transactions.api.mdx index c1409cb72..b819572d3 100644 --- a/api/horizon/resources/list-all-transactions.api.mdx +++ b/api/horizon/resources/list-all-transactions.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful transactions and can be used in sidebar_label: "List All Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions"],"description":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"ListAllTransactions","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"ListAllTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/transactions?cursor=33736968114176&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/transactions?cursor=12884905984&limit=3&order=desc"}},"_embedded":{"records":[{"memo":"hello world","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"account":{"href":"https://horizon.stellar.org/accounts/GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/3"},"operations":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=12884905984"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=12884905984"}},"id":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","paging_token":"12884905984","successful":true,"hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","ledger":3,"created_at":"2015-09-30T17:15:54Z","source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","source_account_sequence":"1","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhAAABLAAAAAAAAAABAAAAAAAAAAEAAAALaGVsbG8gd29ybGQAAAAAAwAAAAAAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAAAAAAAAQAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAN4Lazj4x61AAAAAAAAAAFAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABLaqcIQAAAEBKwqWy3TaOxoGnfm9eUjfTRBvPf34dvDA0Nf+B8z4zBob90UXtuCqmQqwMCyH+okOI3c05br3khkH0yP4kCwcE","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAAAMAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAADAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAMAAAAAAAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhDeC2s5t4PNQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQAAAAAL68IAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAL68IAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDzUAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAwAAAAAAAAAAAZRyYo7njrknFNItA5CWPCTZJ+oAmZlIbokfrC2qnCEAAAAAC+vCAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAAABAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnY/7UAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["SsKlst02jsaBp35vXlI300Qbz39+HbwwNDX/gfM+MwaG/dFF7bgqpkKsDAsh/qJDiN3NOW695IZB9Mj+JAsHBA=="]},{"memo":"testpool,faucet,sdf","_links":{"self":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7841"},"operations":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33676838572032"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33676838572032"}},"id":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","paging_token":"33676838572032","successful":true,"hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","ledger":7841,"created_at":"2015-10-01T04:15:01Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901890","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAABLAAAAAMAAAACAAAAAAAAAAEAAAATdGVzdHBvb2wsZmF1Y2V0LHNkZgAAAAADAAAAAAAAAAAAAAAAH6Ue1GOPj6Hb/ROPyIFCJpQPMujihEIvJSfK0UfMDIgAAAAAC+vCAAAAAAAAAAAAAAAAALMw4P7yJTyqj6ptNh7BPyXEoT+zVwTcU4JVbGyonvgbAAAAAAvrwgAAAAAAAAAAAAAAAABJlwu05Op/5x1uyrweYsyR6pTTos33hRNZe5IF6blnzwAAAAAL68IAAAAAAAAAAAHwXhY2AAAAQDSBB5eNEKkWIoQbZ1YQabJuE5mW/AKhrHTxw9H3m/sai90YcaZlsAe3ueO9jExjSZF289ZcR4vc0wFw1p/WyAc=","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAHqEAAAAAAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAvrwgAAAB6hAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAHqEAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s4+MeHwAAAADAAAAAgAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAB6hAAAAAAAAAACzMOD+8iU8qo+qbTYewT8lxKE/s1cE3FOCVWxsqJ74GwAAAAAL68IAAAAeoQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrODoLZ8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAeoQAAAAAAAAAASZcLtOTqf+cdbsq8HmLMkeqU06LN94UTWXuSBem5Z88AAAAAC+vCAAAAHqEAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAeoQAAAAAAAAAAFvELLeYuDeGJOpfhVQQSnrSkU6sk3FgzUm3FdPBeFjYN4Lazd7T0fAAAAAMAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAB55AAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDuoAAAAAwAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDp8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["NIEHl40QqRYihBtnVhBpsm4TmZb8AqGsdPHD0feb+xqL3RhxpmWwB7e5472MTGNJkXbz1lxHi9zTAXDWn9bIBw=="]},{"memo":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7855"},"operations":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33736968114176"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33736968114176"}},"id":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","paging_token":"33736968114176","successful":true,"hash":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","ledger":7855,"created_at":"2015-10-01T04:16:11Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901891","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAZAAAAAMAAAADAAAAAAAAAAEAAAAAAAAAAQAAAAAAAAAFAAAAAQAAAAAfpR7UY4+Podv9E4/IgUImlA8y6OKEQi8lJ8rRR8wMiAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHwXhY2AAAAQNbDcWsR3s3z8Qzqatcdc/k2L4LXWJMA6eXac8dbXkAdc4ppH25isGC5OwvG06Vwvc3Ce3/r2rYcBP3vxhx18A8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAEAAAABAAAAAQAAHq8AAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s3e09BgAAAADAAAAAwAAAAAAAAABAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAA","fee_meta_xdr":"AAAAAgAAAAMAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPR8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6vAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPQYAAAAAwAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["1sNxaxHezfPxDOpq1x1z+TYvgtdYkwDp5dpzx1teQB1zimkfbmKwYLk7C8bTpXC9zcJ7f+vathwE/e/GHHXwDw=="]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Transactions","description":{"content":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Transactions"],"description":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"ListAllTransactions","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"ListAllTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/transactions?cursor=33736968114176&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/transactions?cursor=12884905984&limit=3&order=desc"}},"_embedded":{"records":[{"memo":"hello world","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"account":{"href":"https://horizon.stellar.org/accounts/GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/3"},"operations":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=12884905984"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=12884905984"}},"id":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","paging_token":"12884905984","successful":true,"hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","ledger":3,"created_at":"2015-09-30T17:15:54Z","source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","source_account_sequence":"1","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhAAABLAAAAAAAAAABAAAAAAAAAAEAAAALaGVsbG8gd29ybGQAAAAAAwAAAAAAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAAAAAAAAQAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAN4Lazj4x61AAAAAAAAAAFAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABLaqcIQAAAEBKwqWy3TaOxoGnfm9eUjfTRBvPf34dvDA0Nf+B8z4zBob90UXtuCqmQqwMCyH+okOI3c05br3khkH0yP4kCwcE","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAAAMAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAADAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAMAAAAAAAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhDeC2s5t4PNQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQAAAAAL68IAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAL68IAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDzUAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAwAAAAAAAAAAAZRyYo7njrknFNItA5CWPCTZJ+oAmZlIbokfrC2qnCEAAAAAC+vCAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAAABAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnY/7UAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["SsKlst02jsaBp35vXlI300Qbz39+HbwwNDX/gfM+MwaG/dFF7bgqpkKsDAsh/qJDiN3NOW695IZB9Mj+JAsHBA=="]},{"memo":"testpool,faucet,sdf","_links":{"self":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7841"},"operations":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33676838572032"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33676838572032"}},"id":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","paging_token":"33676838572032","successful":true,"hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","ledger":7841,"created_at":"2015-10-01T04:15:01Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901890","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAABLAAAAAMAAAACAAAAAAAAAAEAAAATdGVzdHBvb2wsZmF1Y2V0LHNkZgAAAAADAAAAAAAAAAAAAAAAH6Ue1GOPj6Hb/ROPyIFCJpQPMujihEIvJSfK0UfMDIgAAAAAC+vCAAAAAAAAAAAAAAAAALMw4P7yJTyqj6ptNh7BPyXEoT+zVwTcU4JVbGyonvgbAAAAAAvrwgAAAAAAAAAAAAAAAABJlwu05Op/5x1uyrweYsyR6pTTos33hRNZe5IF6blnzwAAAAAL68IAAAAAAAAAAAHwXhY2AAAAQDSBB5eNEKkWIoQbZ1YQabJuE5mW/AKhrHTxw9H3m/sai90YcaZlsAe3ueO9jExjSZF289ZcR4vc0wFw1p/WyAc=","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAHqEAAAAAAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAvrwgAAAB6hAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAHqEAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s4+MeHwAAAADAAAAAgAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAB6hAAAAAAAAAACzMOD+8iU8qo+qbTYewT8lxKE/s1cE3FOCVWxsqJ74GwAAAAAL68IAAAAeoQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrODoLZ8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAeoQAAAAAAAAAASZcLtOTqf+cdbsq8HmLMkeqU06LN94UTWXuSBem5Z88AAAAAC+vCAAAAHqEAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAeoQAAAAAAAAAAFvELLeYuDeGJOpfhVQQSnrSkU6sk3FgzUm3FdPBeFjYN4Lazd7T0fAAAAAMAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAB55AAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDuoAAAAAwAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDp8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["NIEHl40QqRYihBtnVhBpsm4TmZb8AqGsdPHD0feb+xqL3RhxpmWwB7e5472MTGNJkXbz1lxHi9zTAXDWn9bIBw=="]},{"memo":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7855"},"operations":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33736968114176"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33736968114176"}},"id":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","paging_token":"33736968114176","successful":true,"hash":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","ledger":7855,"created_at":"2015-10-01T04:16:11Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901891","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAZAAAAAMAAAADAAAAAAAAAAEAAAAAAAAAAQAAAAAAAAAFAAAAAQAAAAAfpR7UY4+Podv9E4/IgUImlA8y6OKEQi8lJ8rRR8wMiAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHwXhY2AAAAQNbDcWsR3s3z8Qzqatcdc/k2L4LXWJMA6eXac8dbXkAdc4ppH25isGC5OwvG06Vwvc3Ce3/r2rYcBP3vxhx18A8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAEAAAABAAAAAQAAHq8AAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s3e09BgAAAADAAAAAwAAAAAAAAABAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAA","fee_meta_xdr":"AAAAAgAAAAMAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPR8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6vAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPQYAAAAAwAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["1sNxaxHezfPxDOpq1x1z+TYvgtdYkwDp5dpzx1teQB1zimkfbmKwYLk7C8bTpXC9zcJ7f+vathwE/e/GHHXwDw=="]}]}}}}}}}},"method":"get","path":"/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Transactions","description":{"content":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-strict-receive-payment-paths.api.mdx b/api/horizon/resources/list-strict-receive-payment-paths.api.mdx index f2faa9856..c04e1d63e 100644 --- a/api/horizon/resources/list-strict-receive-payment-paths.api.mdx +++ b/api/horizon/resources/list-strict-receive-payment-paths.api.mdx @@ -5,7 +5,7 @@ description: "The strict receive payment path endpoint lists the paths a payment sidebar_label: "List Strict Receive Payment Paths" hide_title: true hide_table_of_contents: true -api: {"tags":["Paths"],"description":"The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the destination_amount are returned.","operationId":"ListStrictReceivePaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"destination_asset_type","in":"path","required":true,"description":"The type for the destination asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"destination_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_asset_code","in":"query","required":false,"description":"The code for the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_amount","in":"path","required":true,"description":"The amount of the destination asset that should be received."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictRecievePaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"28.9871131","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.0722784","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.4000002","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"31.8955888","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"34.7086084","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"asset_type":"native"}]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/paths/strict-receive{destination_asset_type}{destination_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} +api: {"tags":["Paths"],"description":"The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the destination_amount are returned.","operationId":"ListStrictReceivePaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"destination_asset_type","in":"path","required":true,"description":"The type for the destination asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"destination_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_asset_code","in":"query","required":false,"description":"The code for the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_amount","in":"path","required":true,"description":"The amount of the destination asset that should be received."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictRecievePaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"28.9871131","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.0722784","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.4000002","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"31.8955888","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"34.7086084","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"asset_type":"native"}]}]}}}}}}}},"method":"get","path":"/paths/strict-receive{destination_asset_type}{destination_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-strict-send-payment-paths.api.mdx b/api/horizon/resources/list-strict-send-payment-paths.api.mdx index 06a02a78f..e7b9ce1f0 100644 --- a/api/horizon/resources/list-strict-send-payment-paths.api.mdx +++ b/api/horizon/resources/list-strict-send-payment-paths.api.mdx @@ -5,7 +5,7 @@ description: "The strict send payment path endpoint lists the paths a payment ca sidebar_label: "List Strict Send Payment Paths" hide_title: true hide_table_of_contents: true -api: {"tags":["Paths"],"description":"The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned.","operationId":"ListStrictSendPaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"source_asset_type","in":"path","required":true,"description":"The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"source_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the source asset. Required if the source_asset_type is not native."},{"name":"source_asset_code","in":"query","required":false,"description":"The code for the source asset. Required if the source_asset_type is not native."},{"name":"source_amount","in":"path","required":true,"description":"The amount of the source asset that should be sent."},{"name":"destination_account","in":"query","required":false,"description":"The Stellar address of the reciever. Any returned path must end with an asset that the recipient can receive. Using either source_account or source_assets as an argument is required for strict send path payments."},{"name":"destination_assets","in":"query","required":false,"description":"A comma-separated list of assets that the recipient can receive. Any returned path must end with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict send path payments.","schema":{"type":"array","items":{"type":"string"}}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictSendPaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"87.6373649","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"36.0841597","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"16.2264000","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"13.9424750","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"499.8384123","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"498.1069097","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"494.5886542","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"490.0780598","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"280.2909824","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1883029","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1472796","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"62.9386895","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"6.7649849","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"WSD","asset_issuer":"GDSVWEA7XV6M5XNLODVTPCGMAJTNBLZBXOFNQD3BNPNYALEYBNT6CE2V"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"0.0498106","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25155.3452034","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25146.7108397","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24986.8616583","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24948.9784843","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24930.7854717","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"69.7123752","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.9785993","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.6731854","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"63.5394120","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"39.6691360","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"HEX","asset_issuer":"GCGBSZ3DSSH6PRHCOD4JXFNNZXCTKBDFRT4JR2HIAC6FQZU4YK7GPHEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"native","destination_amount":"1226.9231099","path":[]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/paths/strict-send{source_asset_type}{source_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} +api: {"tags":["Paths"],"description":"The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned.","operationId":"ListStrictSendPaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"source_asset_type","in":"path","required":true,"description":"The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"source_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the source asset. Required if the source_asset_type is not native."},{"name":"source_asset_code","in":"query","required":false,"description":"The code for the source asset. Required if the source_asset_type is not native."},{"name":"source_amount","in":"path","required":true,"description":"The amount of the source asset that should be sent."},{"name":"destination_account","in":"query","required":false,"description":"The Stellar address of the reciever. Any returned path must end with an asset that the recipient can receive. Using either source_account or source_assets as an argument is required for strict send path payments."},{"name":"destination_assets","in":"query","required":false,"description":"A comma-separated list of assets that the recipient can receive. Any returned path must end with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict send path payments.","schema":{"type":"array","items":{"type":"string"}}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictSendPaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"87.6373649","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"36.0841597","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"16.2264000","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"13.9424750","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"499.8384123","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"498.1069097","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"494.5886542","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"490.0780598","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"280.2909824","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1883029","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1472796","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"62.9386895","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"6.7649849","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"WSD","asset_issuer":"GDSVWEA7XV6M5XNLODVTPCGMAJTNBLZBXOFNQD3BNPNYALEYBNT6CE2V"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"0.0498106","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25155.3452034","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25146.7108397","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24986.8616583","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24948.9784843","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24930.7854717","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"69.7123752","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.9785993","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.6731854","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"63.5394120","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"39.6691360","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"HEX","asset_issuer":"GCGBSZ3DSSH6PRHCOD4JXFNNZXCTKBDFRT4JR2HIAC6FQZU4YK7GPHEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"native","destination_amount":"1226.9231099","path":[]}]}}}}}}}},"method":"get","path":"/paths/strict-send{source_asset_type}{source_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/lp-retrieve-related-operations.api.mdx b/api/horizon/resources/lp-retrieve-related-operations.api.mdx index 8469bafae..e87f639f3 100644 --- a/api/horizon/resources/lp-retrieve-related-operations.api.mdx +++ b/api/horizon/resources/lp-retrieve-related-operations.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful operations referencing a given sidebar_label: "Retrieve Related Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"LPRetrieveRelatedOperations","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"LPRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192452165550081&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192344791343105&limit=3&order=desc"}},"_embedded":{"records":[{"id":"3697472920621057","paging_token":"3697472920621057","transaction_successful":true,"source_account":"GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L","type":"liquidity_pool_withdraw","type_i":23,"created_at":"2021-11-18T03:47:47Z","transaction_hash":"43ed5ce19190822ec080b67c3ccbab36a56bc34102b1a21d3ee690ed3bc23378","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","reserves_min":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"1000.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"3000.0000005"}],"shares":"200","reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"993.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"}]},{"id":"157639717969326081","paging_token":"157639717969326081","transaction_successful":true,"source_account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"change_trust","type_i":6,"created_at":"2021-08-04T20:01:24Z","transaction_hash":"941f2fa2101d1265696a3c7d35e7688cd210324114e96b64a386ab55f65e488f","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000","trustor":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"LPRetrieveRelatedOperations","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"LPRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192452165550081&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192344791343105&limit=3&order=desc"}},"_embedded":{"records":[{"id":"3697472920621057","paging_token":"3697472920621057","transaction_successful":true,"source_account":"GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L","type":"liquidity_pool_withdraw","type_i":23,"created_at":"2021-11-18T03:47:47Z","transaction_hash":"43ed5ce19190822ec080b67c3ccbab36a56bc34102b1a21d3ee690ed3bc23378","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","reserves_min":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"1000.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"3000.0000005"}],"shares":"200","reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"993.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"}]},{"id":"157639717969326081","paging_token":"157639717969326081","transaction_successful":true,"source_account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"change_trust","type_i":6,"created_at":"2021-08-04T20:01:24Z","transaction_hash":"941f2fa2101d1265696a3c7d35e7688cd210324114e96b64a386ab55f65e488f","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000","trustor":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG"}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/lp-retrieve-related-transactions.api.mdx b/api/horizon/resources/lp-retrieve-related-transactions.api.mdx index 16ae6a509..a45ec122a 100644 --- a/api/horizon/resources/lp-retrieve-related-transactions.api.mdx +++ b/api/horizon/resources/lp-retrieve-related-transactions.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful transactions referencing a giv sidebar_label: "Retrieve Related Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"LPRetrieveRelatedTransactions","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"LPRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"},"account":{"href":"https://horizon.stellar.org/accounts/GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/895788"},"operations":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/operations","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/effects","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=3847380164161536"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=3847380164161536"},"transaction":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"}},"id":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","paging_token":"3847380164161536","successful":true,"hash":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","ledger":895788,"created_at":"2021-08-09T20:53:11Z","source_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","source_account_sequence":"3847371574214658","fee_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","fee_charged":"10000","max_fee":"10001","operation_count":1,"envelope_xdr":"AAAAAgAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAJxEADasqAAAAAgAAAAAAAAAAAAAAAQAAAAEAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAGAAAAAVNFQwAAAAAAm6XFaVsf8OSuS9C9gMplyTjagE9jAnnqwxSDJ6fin6IAsaK8LsUAAAAAAAAAAAAB9uVOlAAAAECXmRsoXmRiJjUrtbkDZYRnzac5s1CVV4g2RlIgBIuQty21npz3A1VhUcSmAx+GmsyGxVFvIrcdstTawJlmy9kF","result_xdr":"AAAAAAAAJxAAAAAAAAAAAQAAAAAAAAAGAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAADassAAAAAQAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAFTRUMAAAAAAJulxWlbH/DkrkvQvYDKZck42oBPYwJ56sMUgyen4p+iAAAAAAAAAAAAsaK8LsUAAAAAAAEAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMADasrAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0nQcAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["l5kbKF5kYiY1K7W5A2WEZ82nObNQlVeINkZSIASLkLcttZ6c9wNVYVHEpgMfhprMhsVRbyK3HbLU2sCZZsvZBQ=="]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"LPRetrieveRelatedTransactions","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"LPRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"},"account":{"href":"https://horizon.stellar.org/accounts/GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/895788"},"operations":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/operations","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/effects","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=3847380164161536"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=3847380164161536"},"transaction":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"}},"id":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","paging_token":"3847380164161536","successful":true,"hash":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","ledger":895788,"created_at":"2021-08-09T20:53:11Z","source_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","source_account_sequence":"3847371574214658","fee_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","fee_charged":"10000","max_fee":"10001","operation_count":1,"envelope_xdr":"AAAAAgAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAJxEADasqAAAAAgAAAAAAAAAAAAAAAQAAAAEAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAGAAAAAVNFQwAAAAAAm6XFaVsf8OSuS9C9gMplyTjagE9jAnnqwxSDJ6fin6IAsaK8LsUAAAAAAAAAAAAB9uVOlAAAAECXmRsoXmRiJjUrtbkDZYRnzac5s1CVV4g2RlIgBIuQty21npz3A1VhUcSmAx+GmsyGxVFvIrcdstTawJlmy9kF","result_xdr":"AAAAAAAAJxAAAAAAAAAAAQAAAAAAAAAGAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAADassAAAAAQAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAFTRUMAAAAAAJulxWlbH/DkrkvQvYDKZck42oBPYwJ56sMUgyen4p+iAAAAAAAAAAAAsaK8LsUAAAAAAAEAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMADasrAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0nQcAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["l5kbKF5kYiY1K7W5A2WEZ82nObNQlVeINkZSIASLkLcttZ6c9wNVYVHEpgMfhprMhsVRbyK3HbLU2sCZZsvZBQ=="]}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/retrieve-an-order-book.api.mdx b/api/horizon/resources/retrieve-an-order-book.api.mdx index 6228b3dd8..b3f9cf6e8 100644 --- a/api/horizon/resources/retrieve-an-order-book.api.mdx +++ b/api/horizon/resources/retrieve-an-order-book.api.mdx @@ -5,7 +5,7 @@ description: "The order book endpoint provides an order book’s bids and asks a sidebar_label: "Retrieve an Order Book" hide_title: true hide_table_of_contents: true -api: {"tags":["Order Books"],"description":"The order book endpoint provides an order book’s bids and asks and can be used in streaming mode. When filtering for a specific order book, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"RetrieveAnOrderBook","parameters":[{"name":"selling_asset_type","in":"path","required":true,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"bids":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"asks":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"base":{"type":"object","properties":{"asset_type":{"type":"string"}}},"counter":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"title":"OrderBook"},"examples":{"RetrieveAnOrderBook":{"value":{"bids":[{"price_r":{"n":10000000,"d":139999999},"price":"0.0714286","amount":"24.9999990"},{"price_r":{"n":1,"d":14},"price":"0.0714286","amount":"188.0000000"},{"price_r":{"n":1,"d":15},"price":"0.0666667","amount":"230.3200000"},{"price_r":{"n":1,"d":16},"price":"0.0625000","amount":"50.0000000"}],"asks":[{"price_r":{"n":5000000,"d":62500001},"price":"0.0800000","amount":"4.9400001"},{"price_r":{"n":10000000,"d":125000001},"price":"0.0800000","amount":"2516.5154327"},{"price_r":{"n":2,"d":25},"price":"0.0800000","amount":"3125.0000000"},{"price_r":{"n":4,"d":49},"price":"0.0816327","amount":"4593.7500000"}],"base":{"asset_type":"native"},"counter":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/order_books{selling_asset_type}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} +api: {"tags":["Order Books"],"description":"The order book endpoint provides an order book’s bids and asks and can be used in streaming mode. When filtering for a specific order book, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"RetrieveAnOrderBook","parameters":[{"name":"selling_asset_type","in":"path","required":true,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"bids":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"asks":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"base":{"type":"object","properties":{"asset_type":{"type":"string"}}},"counter":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"title":"OrderBook"},"examples":{"RetrieveAnOrderBook":{"value":{"bids":[{"price_r":{"n":10000000,"d":139999999},"price":"0.0714286","amount":"24.9999990"},{"price_r":{"n":1,"d":14},"price":"0.0714286","amount":"188.0000000"},{"price_r":{"n":1,"d":15},"price":"0.0666667","amount":"230.3200000"},{"price_r":{"n":1,"d":16},"price":"0.0625000","amount":"50.0000000"}],"asks":[{"price_r":{"n":5000000,"d":62500001},"price":"0.0800000","amount":"4.9400001"},{"price_r":{"n":10000000,"d":125000001},"price":"0.0800000","amount":"2516.5154327"},{"price_r":{"n":2,"d":25},"price":"0.0800000","amount":"3125.0000000"},{"price_r":{"n":4,"d":49},"price":"0.0816327","amount":"4593.7500000"}],"base":{"asset_type":"native"},"counter":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"}}}}}}}},"method":"get","path":"/order_books{selling_asset_type}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/retrieve-related-effects.api.mdx b/api/horizon/resources/retrieve-related-effects.api.mdx index f0257f5cf..c6f5c0b42 100644 --- a/api/horizon/resources/retrieve-related-effects.api.mdx +++ b/api/horizon/resources/retrieve-related-effects.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents effects referencing a given liquidity poo sidebar_label: "Retrieve Related Effects" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"RetrieveRelatedEffects","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["Account Created","Account Removed","Account Credited","Account Debited","Account Thresholds Updated","Account Home Domain Updated","Account Flags Updated","Account Inflation Destination Updated","Signer Created","Signer Removed","Signer Updated","Trustline Created","Trustline Removed","Trustline Updated","Trustline Authorized","Trustline Deauthorized","Offer Created","Offer Removed","Offer Updated","Trade","Data Created","Data Removed","Data Updated","Claimable Balance Created","Claimable Balance Claimant Created","Claimable Balance Claimed","Account Sponsorship Created","Account Sponsorship Updated","Account Sponsorship Removed","Trustline Sponsorship Created","Trustline Sponsorship Updated","Trustline Sponsorship Removed","Account Data Sponsorship Created","Account Data Sponsorship Updated","Account Data Sponsorship Removed","Claimable Balance Sponsorship Created","Claimable Balance Sponsorship Updated","Claimable Balance Sponsorship Removed","Account Signer Sponsorship Created","Account Signer Sponsorship Updated","Account Signer Sponsorship Removed","Liquidity Pool Created","Liquidity Pool Removed","Liquidity Pool Revoked","Liquidity Pool Deposited","Liquidity Pool Withdraw","Liquidity Pool Trade","Sequence Bumped"]},"type_i":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"RetrieveRelatedEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192370561220608&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192344791343104&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/3849085266190337"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=3849085266190337-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=3849085266190337-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_deposited","type_i":81,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_deposited":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"}],"shares_received":"1000"},{"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_withdrew","type_i":82,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005"}],"shares_redeemed":"1000"},{"id":"0000000012884905986-0000000003","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_trade","type_i":83,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"sold":{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"},"bought":{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"}},{"id":"0000000012884905986-0000000004","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_created","type_i":84,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"1","total_shares":"0","reserves":[{"amount":"0","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"0","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]}},{"id":"0000000012884905986-0000000005","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_removed","type_i":85,"created_at":"2021-11-18T03:15:54Z","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9"},{"id":"0000000012884905986-0000000006","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_revoked","type_i":86,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_revoked":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005","claimable_balance_id":"idcbd1234"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005","claimable_balance_id":"cbid1235"}],"shares_revoked":"1000"},{"id":"0000000012884905986-0000000007","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_created","type_i":20,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000"},{"id":"0000000012884905986-0000000008","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_updated","type_i":22,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"2000"},{"id":"0000000012884905986-0000000009","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_removed","type_i":21,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"0.0000000"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Effects","description":{"content":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"RetrieveRelatedEffects","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["Account Created","Account Removed","Account Credited","Account Debited","Account Thresholds Updated","Account Home Domain Updated","Account Flags Updated","Account Inflation Destination Updated","Signer Created","Signer Removed","Signer Updated","Trustline Created","Trustline Removed","Trustline Updated","Trustline Authorized","Trustline Deauthorized","Offer Created","Offer Removed","Offer Updated","Trade","Data Created","Data Removed","Data Updated","Claimable Balance Created","Claimable Balance Claimant Created","Claimable Balance Claimed","Account Sponsorship Created","Account Sponsorship Updated","Account Sponsorship Removed","Trustline Sponsorship Created","Trustline Sponsorship Updated","Trustline Sponsorship Removed","Account Data Sponsorship Created","Account Data Sponsorship Updated","Account Data Sponsorship Removed","Claimable Balance Sponsorship Created","Claimable Balance Sponsorship Updated","Claimable Balance Sponsorship Removed","Account Signer Sponsorship Created","Account Signer Sponsorship Updated","Account Signer Sponsorship Removed","Liquidity Pool Created","Liquidity Pool Removed","Liquidity Pool Revoked","Liquidity Pool Deposited","Liquidity Pool Withdraw","Liquidity Pool Trade","Sequence Bumped"]},"type_i":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"RetrieveRelatedEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192370561220608&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192344791343104&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/3849085266190337"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=3849085266190337-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=3849085266190337-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_deposited","type_i":81,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_deposited":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"}],"shares_received":"1000"},{"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_withdrew","type_i":82,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005"}],"shares_redeemed":"1000"},{"id":"0000000012884905986-0000000003","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_trade","type_i":83,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"sold":{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"},"bought":{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"}},{"id":"0000000012884905986-0000000004","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_created","type_i":84,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"1","total_shares":"0","reserves":[{"amount":"0","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"0","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]}},{"id":"0000000012884905986-0000000005","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_removed","type_i":85,"created_at":"2021-11-18T03:15:54Z","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9"},{"id":"0000000012884905986-0000000006","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_revoked","type_i":86,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_revoked":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005","claimable_balance_id":"idcbd1234"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005","claimable_balance_id":"cbid1235"}],"shares_revoked":"1000"},{"id":"0000000012884905986-0000000007","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_created","type_i":20,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000"},{"id":"0000000012884905986-0000000008","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_updated","type_i":22,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"2000"},{"id":"0000000012884905986-0000000009","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_removed","type_i":21,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"0.0000000"}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Effects","description":{"content":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/retrieve-related-trades.api.mdx b/api/horizon/resources/retrieve-related-trades.api.mdx index 1c818b19a..963a980ba 100644 --- a/api/horizon/resources/retrieve-related-trades.api.mdx +++ b/api/horizon/resources/retrieve-related-trades.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful trades fulfilled by the given sidebar_label: "Retrieve Related Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trade created since your request time. ","operationId":"RetrieveRelatedTrades","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveRelatedTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G"},"counter":{"href":"https://horizon.stellar.org/accounts/GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L"},"operation":{"href":"https://horizon.stellar.org/operations/3697472920621057"}},"id":"3697472920621057-0","paging_token":"3697472920621057-0","ledger_close_time":"2015-11-18T03:47:47Z","offer_id":"9","base_offer_id":"9","base_account":"GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G","base_amount":"10.0000000","base_asset_type":"native","counter_liquidity_pool":"3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4","liquidity_pool_fee_bp":"30","counter_amount":"2.6700000","counter_asset_type":"credit_alphanum4","counter_asset_code":"JPY","counter_asset_issuer":"GBVAOIACNSB7OVUXJYC5UE2D4YK2F7A24T7EE5YOMN4CE6GCHUTOUQXM","base_is_seller":true,"price":{"n":"267","d":"1000"},"trade_type":"liquidity_pool"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Trades","description":{"content":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trade created since your request time. ","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trade created since your request time. ","operationId":"RetrieveRelatedTrades","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveRelatedTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G"},"counter":{"href":"https://horizon.stellar.org/accounts/GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L"},"operation":{"href":"https://horizon.stellar.org/operations/3697472920621057"}},"id":"3697472920621057-0","paging_token":"3697472920621057-0","ledger_close_time":"2015-11-18T03:47:47Z","offer_id":"9","base_offer_id":"9","base_account":"GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G","base_amount":"10.0000000","base_asset_type":"native","counter_liquidity_pool":"3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4","liquidity_pool_fee_bp":"30","counter_amount":"2.6700000","counter_asset_type":"credit_alphanum4","counter_asset_code":"JPY","counter_asset_issuer":"GBVAOIACNSB7OVUXJYC5UE2D4YK2F7A24T7EE5YOMN4CE6GCHUTOUQXM","base_is_seller":true,"price":{"n":"267","d":"1000"},"trade_type":"liquidity_pool"}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Trades","description":{"content":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trade created since your request time. ","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/index.mdx b/api/index.mdx index 84844ad7a..4861368e4 100644 --- a/api/index.mdx +++ b/api/index.mdx @@ -24,3 +24,10 @@ Stellar Ecosystem Proposals (SEPs), to make it easy for businesses to integrate with Stellar-based wallets and exchanges. [Learn more about the Anchor Platform API here!](/api/anchor-platform) + +## Stellar Disbursement Platform + +The Stellar Disbursement Platform (SDP) enables organizations to disburse bulk +payments to recipients using Stellar. + +[Learn more about the Stellar Disbursement Platform API here!](/api/stellar-disbursement-platform) \ No newline at end of file diff --git a/api/stellar-disbursement-platform/introduction/_category_.json b/api/stellar-disbursement-platform/introduction/_category_.json new file mode 100644 index 000000000..545254b2c --- /dev/null +++ b/api/stellar-disbursement-platform/introduction/_category_.json @@ -0,0 +1,4 @@ +{ + "position": 10, + "label": "Introduction" +} \ No newline at end of file diff --git a/api/stellar-disbursement-platform/introduction/index.mdx b/api/stellar-disbursement-platform/introduction/index.mdx new file mode 100644 index 000000000..3488cd34c --- /dev/null +++ b/api/stellar-disbursement-platform/introduction/index.mdx @@ -0,0 +1,9 @@ +--- +title: Stellar Disbursement Platform API Reference +sidebar_position: 10 +slug: /stellar-disbursement-platform +--- + +The Stellar Disbursement Platform (SDP) enables organizations to disburse bulk payments to recipients using Stellar. + +This section includes the API reference for the Stellar Disbursement Platform. To learn more about the Stellar Disbursement Platform and how to run it, check out the [documentation](/docs/stellar-disbursement-platform/overview). \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/_category_.json b/api/stellar-disbursement-platform/resources/_category_.json new file mode 100644 index 000000000..9aac71963 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/_category_.json @@ -0,0 +1,5 @@ +{ + "position": 20, + "label": "Resources" +} + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/auth/index.mdx b/api/stellar-disbursement-platform/resources/auth/index.mdx new file mode 100644 index 000000000..6c71ecb25 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/auth/index.mdx @@ -0,0 +1,21 @@ +--- +title: Authentication +order: 0 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +Authentication controls the log in/log out process for all SDP users, as well as the token refresh process. Authentication uses a JWT approach signed with an ES256 private key. + + + +| | | +| --- | --------------------- | +| POST | [/login](../log-in.api.mdx) | +| POST | [/refresh-token](../refresh-token.api.mdx) | +| POST | [/mfa](../authenticate-mfa.api.mdx) | +| POST | [/forgot-password](../forgot-password.api.mdx) | +| POST | [/reset-password](../reset-password.api.mdx) | + + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx b/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx new file mode 100644 index 000000000..5580bb2b8 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx @@ -0,0 +1,49 @@ +--- +id: authenticate-mfa +title: "Provide Multi-Factor Authentication" +description: "Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required." +sidebar_label: "Provide Multi-Factor Authentication" +hide_title: true +hide_table_of_contents: true +api: {"description":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","operationId":"authenticateMFA","tags":["Authentication"],"parameters":[{"in":"header","name":"Device-ID","required":false,"description":"Identifier of the device","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfa_code":{"type":"string","description":"Multi-factor authentication code"},"remember_me":{"type":"boolean","description":"Boolean flag to remember the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true."}},"required":["mfa_code"]}}},"description":"MFA request data","required":true},"responses":{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"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":"/mfa","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"mfa_code":"string","remember_me":true,"recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Multi-Factor Authentication","description":{"content":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","type":"text/plain"},"url":{"path":["mfa"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Identifier of the device","type":"text/plain"},"key":"Device-ID","value":""},{"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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Provide Multi-Factor Authentication + + + +Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required. + +
    Header Parameters
    Request Body required
    + +MFA request data + +
    + +Successful authentication + +
    Schema
    + +Bad Request + +
    Schema
    + +Unauthorized + +
    Response Headers
      Schema
        extras object
      diff --git a/api/stellar-disbursement-platform/resources/create-asset.api.mdx b/api/stellar-disbursement-platform/resources/create-asset.api.mdx new file mode 100644 index 000000000..21c59f027 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/create-asset.api.mdx @@ -0,0 +1,45 @@ +--- +id: create-asset +title: "Create Asset" +description: "This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement." +sidebar_label: "Create Asset" +hide_title: true +hide_table_of_contents: true +api: {"description":"This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","tags":["Organization"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The asset code","example":"USDC"},"issuer":{"type":"string","description":"The issuer","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"}},"required":["code","issuer"]}}},"description":"Asset to be created","required":true},"responses":{"201":{"description":"Asset created successfully"},"400":{"description":"Bad request, invalid request body or the provided code/issuer is invalid."}},"security":[{"BearerAuth":[]}],"method":"post","path":"/assets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"code":"USDC","issuer":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create Asset","description":{"content":"This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Asset + + + +This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement. + +
      Request Body required
      + +Asset to be created + +
      + +Asset created successfully + +
      + +Bad request, invalid request body or the provided code/issuer is invalid. + +
      diff --git a/api/stellar-disbursement-platform/resources/create-disbursement.api.mdx b/api/stellar-disbursement-platform/resources/create-disbursement.api.mdx new file mode 100644 index 000000000..28cd2e21c --- /dev/null +++ b/api/stellar-disbursement-platform/resources/create-disbursement.api.mdx @@ -0,0 +1,49 @@ +--- +id: create-disbursement +title: "Create Disbursement" +description: "Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```." +sidebar_label: "Create Disbursement" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"201":{"description":"A new disbursement","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Country code in ISO 3166 alpha-3","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Bad request","extras":{"status":400,"message":"Invalid country code provided"}}},"examples":{"response":{"value":{"error":"Bad request","extras":{"status":400,"message":"Invalid country code provided"}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Create Disbursement","description":"Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.","tags":["Disbursements"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"wallet_id":{"type":"string"},"asset_id":{"type":"string"},"country_code":{"type":"string","description":"Two-character ISO 3166 code"}},"example":{"name":"My New Disbursement name","wallet_id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","asset_id":"d227a68c-2f40-11ee-be56-0242ac120002","country_code":"ua"}}}}},"security":[{"BearerAuth":[]}],"method":"post","path":"/disbursements","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"name":"My New Disbursement name","wallet_id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","asset_id":"d227a68c-2f40-11ee-be56-0242ac120002","country_code":"ua"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create Disbursement","description":{"content":"Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.","type":"text/plain"},"url":{"path":["disbursements"],"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"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Disbursement + + + +Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```. + +
      Request Body
      + +A new disbursement + +
      Schema
        country object
        wallet object
        asset object
        status_history object[]
      • Array [
      • ]
      + +Bad Request + +
      Response Headers
        Schema
          extras object
        + +Unauthorized + +
        Response Headers
          Schema
            extras object
          + +Forbidden + +
          Response Headers
            Schema
            diff --git a/api/stellar-disbursement-platform/resources/create-user.api.mdx b/api/stellar-disbursement-platform/resources/create-user.api.mdx new file mode 100644 index 000000000..05e10f44a --- /dev/null +++ b/api/stellar-disbursement-platform/resources/create-user.api.mdx @@ -0,0 +1,45 @@ +--- +id: create-user +title: "Create User" +description: "This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email." +sidebar_label: "Create User" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Create User","description":"This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"email":{"type":"string"}},"example":{"first_name":"John","last_name":"Doe","roles":["business"],"email":"email@email.com"}}}}},"security":[{"BearerAuth":[]}],"method":"post","path":"/users","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"first_name":"John","last_name":"Doe","roles":["business"],"email":"email@email.com"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Create User","description":{"content":"This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.","type":"text/plain"},"url":{"path":["users"],"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"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create User + + + +This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email. + +
            Request Body
            + +Created + +
            Schema
            + +Unauthorized + +
            Response Headers
              Schema
                extras object
              + +Forbidden + +
              Response Headers
                Schema
                diff --git a/api/stellar-disbursement-platform/resources/delete-asset.api.mdx b/api/stellar-disbursement-platform/resources/delete-asset.api.mdx new file mode 100644 index 000000000..6361915a0 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/delete-asset.api.mdx @@ -0,0 +1,45 @@ +--- +id: delete-asset +title: "Delete Asset" +description: "This endpoint is used to soft delete an asset." +sidebar_label: "Delete Asset" +hide_title: true +hide_table_of_contents: true +api: {"description":"This endpoint is used to soft delete an asset.","tags":["Organization"],"parameters":[{"name":"id","in":"path","description":"ID of the asset to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Asset deleted successfully"},"204":{"description":"Asset already deleted"},"404":{"description":"Asset not found"}},"security":[{"BearerAuth":[]}],"method":"delete","path":"/assets/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Delete Asset","description":{"content":"This endpoint is used to soft delete an asset.","type":"text/plain"},"url":{"path":["assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the asset to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "delete api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Asset + + + +This endpoint is used to soft delete an asset. + +
                Path Parameters
                + +Asset deleted successfully + +
                + +Asset already deleted + +
                + +Asset not found + +
                diff --git a/api/stellar-disbursement-platform/resources/disbursements/index.mdx b/api/stellar-disbursement-platform/resources/disbursements/index.mdx new file mode 100644 index 000000000..88a277be4 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/disbursements/index.mdx @@ -0,0 +1,22 @@ +--- +title: Disbursements +order: 1 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +A disbursement is a group of payments sent to multiple individuals at once. An SDP user with the appropriate role triggers a new disbursement through the SDP dashboard by uploading a list of receivers and amounts. When the receiver has linked their wallet to the SDP, the payment automatically begins. SDP users can track their disbursements in real-time through the SDP dashboard. Each disbursement must have a unique name defined by the organization. + + + +| | | +| --- | --------------------- | +| GET | [/disbursements](../list-all-disbursements.api.mdx) | +| POST | [/disbursements](../create-disbursement.api.mdx) | +| GET | [/disbursements/:id](../retrieve-a-disbursement.api.mdx) | +| GET | [/disbursements/:id/receivers](../list-all-disbursement-receivers.api.mdx) | +| POST | [/disbursements/:id/instructions](../upload-disbursement-instructions.api.mdx) | +| GET | [/disbursements/:id/instructions](../download-disbursement-instructions.api.mdx) | +| PATCH | [/disbursements/:id/status](../update-a-disbursement-status.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx b/api/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx new file mode 100644 index 000000000..f4f0cfd23 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/download-disbursement-instructions.api.mdx @@ -0,0 +1,61 @@ +--- +id: download-disbursement-instructions +title: "Download Disbursement Instructions" +description: "Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement." +sidebar_label: "Download Disbursement Instructions" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Disbursement CSV file","headers":{"Content-Disposition":{"description":"The filename of the returned CSV file.","schema":{"type":"string"}},"Content-Type":{"description":"text/csv","schema":{"type":"string"}}},"content":{"text/csv":{"examples":{"response":{"value":""}}}}},"400":{"description":"Bad Request","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"foo":{"type":"string"},"message":{"type":"string"}}}},"example":{"error":"Invalid request","extras":{"foo":"bar","message":"Invalid request parameters"}}}},"application/json":{"examples":{"response":{"value":{"error":"Invalid request","extras":{"foo":"bar","message":"Invalid request parameters"}}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}}},"application/json":{"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"text/csv":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}},"application/json":{"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Download Disbursement Instructions","description":"Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}/instructions","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Download Disbursement Instructions","description":{"content":"Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.","type":"text/plain"},"url":{"path":["disbursements",":id","instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download Disbursement Instructions + + + +Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement. + +
                Path Parameters
                + +Disbursement CSV file + +
                Response Headers
                • Content-Disposition string
                  + +The filename of the returned CSV file. + +
                • Content-Type string
                  + +text/csv + +
                Schema
                  any
                + +Bad Request + +
                Response Headers
                  Schema
                    extras object
                  Schema
                    any
                  + +Unauthorized + +
                  Response Headers
                    Schema
                      extras object
                    Schema
                      any
                    + +Forbidden + +
                    Response Headers
                      Schema
                      Schema
                        any
                      + +Not Found + +
                      Response Headers
                        Schema
                          extras object
                        Schema
                          any
                        diff --git a/api/stellar-disbursement-platform/resources/forgot-password.api.mdx b/api/stellar-disbursement-platform/resources/forgot-password.api.mdx new file mode 100644 index 000000000..ad8a162ad --- /dev/null +++ b/api/stellar-disbursement-platform/resources/forgot-password.api.mdx @@ -0,0 +1,45 @@ +--- +id: forgot-password +title: "Forgot Password" +description: "Sends an email with a token to an SDP user who has gone through the Forgot Password process." +sidebar_label: "Forgot Password" +hide_title: true +hide_table_of_contents: true +api: {"description":"Sends an email with a token to an SDP user who has gone through the Forgot Password process.","operationId":"forgotPassword","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email of the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation"}},"required":["email"]}}},"description":"Forgot password request data","required":true},"responses":{"200":{"description":"Forgot password email sent successfully","content":{"*/*":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}}},"method":"post","path":"/forgot-password","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"user@example.com","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Forgot Password","description":{"content":"Sends an email with a token to an SDP user who has gone through the Forgot Password process.","type":"text/plain"},"url":{"path":["forgot-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Forgot Password + + + +Sends an email with a token to an SDP user who has gone through the Forgot Password process. + +
                        Request Body required
                        + +Forgot password request data + +
                        + +Forgot password email sent successfully + +
                        Schema
                        + +Bad Request + +
                        Schema
                        diff --git a/api/stellar-disbursement-platform/resources/get-all-assets.api.mdx b/api/stellar-disbursement-platform/resources/get-all-assets.api.mdx new file mode 100644 index 000000000..78aaaaa32 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-all-assets.api.mdx @@ -0,0 +1,45 @@ +--- +id: get-all-assets +title: "Get All Assets" +description: "Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement." +sidebar_label: "Get All Assets" +hide_title: true +hide_table_of_contents: true +api: {"description":"Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","tags":["Organization"],"responses":{"200":{"description":"A list of assets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/assets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Assets","description":{"content":"Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get All Assets + + + +Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement. + +
                        + +A list of assets + +
                        Schema
                        • Array [
                        • ]
                        + +Unauthorized + +
                        Response Headers
                          Schema
                            extras object
                          + +Forbidden + +
                          Response Headers
                            Schema
                            diff --git a/api/stellar-disbursement-platform/resources/get-all-countries.api.mdx b/api/stellar-disbursement-platform/resources/get-all-countries.api.mdx new file mode 100644 index 000000000..0d518a1cc --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-all-countries.api.mdx @@ -0,0 +1,45 @@ +--- +id: get-all-countries +title: "Get All Countries" +description: "Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers." +sidebar_label: "Get All Countries" +hide_title: true +hide_table_of_contents: true +api: {"description":"Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.","tags":["Organization"],"responses":{"200":{"description":"A list of countries","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Country code in ISO 3166 alpha-3","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/countries","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Countries","description":{"content":"Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.","type":"text/plain"},"url":{"path":["countries"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get All Countries + + + +Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers. + +
                            + +A list of countries + +
                            Schema
                            • Array [
                            • ]
                            + +Unauthorized + +
                            Response Headers
                              Schema
                                extras object
                              + +Forbidden + +
                              Response Headers
                                Schema
                                diff --git a/api/stellar-disbursement-platform/resources/get-all-roles.api.mdx b/api/stellar-disbursement-platform/resources/get-all-roles.api.mdx new file mode 100644 index 000000000..342efe0a9 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-all-roles.api.mdx @@ -0,0 +1,45 @@ +--- +id: get-all-roles +title: "Get All Roles" +description: "Fetches available SDP roles, such as owner, financial controller, business user, and developer." +sidebar_label: "Get All Roles" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}}},"example":{"roles":["developer","financial_controller","business","owner"]}},"examples":{"response":{"value":{"roles":["developer","financial_controller","business","owner"]}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Get All Roles","description":"Fetches available SDP roles, such as owner, financial controller, business user, and developer.","tags":["Users"],"security":[{"BearerAuth":[]}],"method":"get","path":"/users/roles","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Roles","description":{"content":"Fetches available SDP roles, such as owner, financial controller, business user, and developer.","type":"text/plain"},"url":{"path":["users","roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get All Roles + + + +Fetches available SDP roles, such as owner, financial controller, business user, and developer. + +
                                + +OK + +
                                Response Headers
                                  Schema
                                  + +Unauthorized + +
                                  Response Headers
                                    Schema
                                      extras object
                                    + +Forbidden + +
                                    Response Headers
                                      Schema
                                      diff --git a/api/stellar-disbursement-platform/resources/get-all-users.api.mdx b/api/stellar-disbursement-platform/resources/get-all-users.api.mdx new file mode 100644 index 000000000..7d80c85d9 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-all-users.api.mdx @@ -0,0 +1,45 @@ +--- +id: get-all-users +title: "Get All Users" +description: "Fetches all SDP users within the organization, whether they are active yet or not." +sidebar_label: "Get All Users" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Returns a paginated list of User Details","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Get All Users","description":"Fetches all SDP users within the organization, whether they are active yet or not.","tags":["Users"],"security":[{"BearerAuth":[]}],"method":"get","path":"/users","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Users","description":{"content":"Fetches all SDP users within the organization, whether they are active yet or not.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get All Users + + + +Fetches all SDP users within the organization, whether they are active yet or not. + +
                                      + +Returns a paginated list of User Details + +
                                      Schema
                                      • Array [
                                      • ]
                                      + +Unauthorized + +
                                      Response Headers
                                        Schema
                                          extras object
                                        + +Forbidden + +
                                        Response Headers
                                          Schema
                                          diff --git a/api/stellar-disbursement-platform/resources/get-all-wallets.api.mdx b/api/stellar-disbursement-platform/resources/get-all-wallets.api.mdx new file mode 100644 index 000000000..0ebbaf93f --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-all-wallets.api.mdx @@ -0,0 +1,45 @@ +--- +id: get-all-wallets +title: "Get All Wallets" +description: "Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets." +sidebar_label: "Get All Wallets" +hide_title: true +hide_table_of_contents: true +api: {"description":"Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.","tags":["Organization"],"responses":{"200":{"description":"A list of wallets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"security":[{"BearerAuth":[]}],"method":"get","path":"/wallets","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get All Wallets","description":{"content":"Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.","type":"text/plain"},"url":{"path":["wallets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get All Wallets + + + +Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets. + +
                                          + +A list of wallets + +
                                          Schema
                                          • Array [
                                          • ]
                                          + +Unauthorized + +
                                          Response Headers
                                            Schema
                                              extras object
                                            + +Forbidden + +
                                            Response Headers
                                              Schema
                                              diff --git a/api/stellar-disbursement-platform/resources/get-organization-info.api.mdx b/api/stellar-disbursement-platform/resources/get-organization-info.api.mdx new file mode 100644 index 000000000..fc5781ec4 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-organization-info.api.mdx @@ -0,0 +1,41 @@ +--- +id: get-organization-info +title: "Get Organization Info" +description: "This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account." +sidebar_label: "Get Organization Info" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Returns organization details","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Stellar Aid"},"logo_url":{"type":"string","example":"https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo"},"distribution_account_public_key":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"timezone_utc_offset":{"type":"string","example":"+00:00"},"is_approval_workflow_enabled":{"description":"Enables multi-user approval workflow for disbursements","type":"boolean","example":true}}}}}},"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"}}}}}}}},"operationId":"Get Organization Info","description":"This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.","tags":["Organization"],"security":[{"BearerAuth":[]}],"method":"get","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get Organization Info","description":{"content":"This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Organization Info + + + +This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account. + +
                                              + +Returns organization details + +
                                              Schema
                                              + +Unauthorized + +
                                              Response Headers
                                                Schema
                                                  extras object
                                                diff --git a/api/stellar-disbursement-platform/resources/get-organization-logo.api.mdx b/api/stellar-disbursement-platform/resources/get-organization-logo.api.mdx new file mode 100644 index 000000000..3b4738e85 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-organization-logo.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-organization-logo +title: "Retrieve Organization Logo" +description: "Retrieves the logo of the organization for display in the UI navbar." +sidebar_label: "Retrieve Organization Logo" +hide_title: true +hide_table_of_contents: true +api: {"description":"Retrieves the logo of the organization for display in the UI navbar.","operationId":"GetOrganizationLogo","tags":["Organization"],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"method":"get","path":"/organization/logo","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Organization Logo","description":{"content":"Retrieves the logo of the organization for display in the UI navbar.","type":"text/plain"},"url":{"path":["organization","logo"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/octet-stream"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve Organization Logo + + + +Retrieves the logo of the organization for display in the UI navbar. + +
                                                + +OK + +
                                                Schema
                                                • string binary
                                                diff --git a/api/stellar-disbursement-platform/resources/get-profile.api.mdx b/api/stellar-disbursement-platform/resources/get-profile.api.mdx new file mode 100644 index 000000000..2c6639548 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/get-profile.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-profile +title: "Get Profile" +description: "Fetches the individual information of the logged in user to populate the Profile page." +sidebar_label: "Get Profile" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Returns user profile","content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","example":"Jane"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string","example":"jdoe@mail.org"},"roles":{"type":"array","items":{"type":"string"}},"organization_name":{"type":"string"}},"example":{"first_name":"Jane","last_name":"Doe","email":"jdoe@mail.org","roles":["developer"],"organization_name":"Stellar Aid"}}}}}},"operationId":"Get Profile","description":"Fetches the individual information of the logged in user to populate the Profile page.","tags":["Profile"],"security":[{"BearerAuth":[]}],"method":"get","path":"/profile","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Get Profile","description":{"content":"Fetches the individual information of the logged in user to populate the Profile page.","type":"text/plain"},"url":{"path":["profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Profile + + + +Fetches the individual information of the logged in user to populate the Profile page. + +
                                                + +Returns user profile + +
                                                Schema
                                                diff --git a/api/stellar-disbursement-platform/resources/index.mdx b/api/stellar-disbursement-platform/resources/index.mdx new file mode 100644 index 000000000..ab834de2c --- /dev/null +++ b/api/stellar-disbursement-platform/resources/index.mdx @@ -0,0 +1,24 @@ +--- +title: Resources +sidebar_position: 20 +--- + +import {MethodTable} from "@site/src/components/MethodTable"; + +Data on the Stellar Disbursement Platform is organized according to resources. Each resource has several different endpoints. + + + +| | | +| --------------------------------------------------- | --- | +| [Authentication](./auth/index.mdx) | | +| [Disbursements](./disbursements/index.mdx) | | +| [Organization](./organization/index.mdx) | | +| [Payments](./payments/index.mdx) | | +| [Profiles](./profile/index.mdx) | | +| [Receivers](./receivers/index.mdx) | | +| [Registration](./registration/index.mdx) | | +| [Statistics](./statistics/index.mdx) | | +| [Users](./users/index.mdx) | | + + \ No newline at end of file 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 new file mode 100644 index 000000000..6cf41dbd3 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/list-all-disbursement-receivers.api.mdx @@ -0,0 +1,49 @@ +--- +id: list-all-disbursement-receivers +title: "List All Disbursement Receivers" +description: "Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination." +sidebar_label: "List All Disbursement Receivers" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"A list of Disbursement Receivers","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec3a57c0-5660-4b5a-af76-acadc7b09b93"},"email":{"type":"string","example":"receiver@mail.org"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr129001"},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}},"payment":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"List All Disbursement Receivers","description":"Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number to fetch.","required":false,"schema":{"type":"number"}},{"name":"page_limit","in":"query","description":"The number of records to return per page.","required":false,"schema":{"type":"number"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}/receivers","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Disbursement Receivers","description":{"content":"Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.","type":"text/plain"},"url":{"path":["disbursements",":id","receivers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page number to fetch.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"The number of records to return per page.","type":"text/plain"},"key":"page_limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List All Disbursement Receivers + + + +Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination. + +
                                                Path Parameters
                                                Query Parameters
                                                + +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
                                                  asset object
                                                  receiver_wallet object
                                                  receiver object
                                                  wallet object
                                                • ]
                                                + +Unauthorized + +
                                                Response Headers
                                                  Schema
                                                    extras object
                                                  + +Forbidden + +
                                                  Response Headers
                                                    Schema
                                                    + +Not Found + +
                                                    Response Headers
                                                      Schema
                                                        extras object
                                                      diff --git a/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx b/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx new file mode 100644 index 000000000..a05059e67 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/list-all-disbursements.api.mdx @@ -0,0 +1,45 @@ +--- +id: list-all-disbursements +title: "List All Disbursements" +description: "Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement." +sidebar_label: "List All Disbursements" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"A list of Disbursement details","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Country code in ISO 3166 alpha-3","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}},"example":{"pagination":{"next":"/disbursements?page=3&page_limit=1","prev":"/disbursements?page=1&page_limit=1","pages":4,"total":4},"data":{"id":"619da857-8725-4c58-933d-c120a458e0f5","name":"Disbursement Name","country":{"code":"UKR","name":"Ukraine","created_at":"2023-02-03T10:45:51.000Z","updated_at":"2023-02-03T10:45:51.000Z"},"wallet":{"id":"e2de8544-b7e2-40a9-ad40-411f70d5c4bf","name":"Vibrant","homepage":"https://vibrantapp.com"},"asset":{"id":"25923001-508a-4629-9186-c41211b2a3d0","code":"USDC","issuer":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"status":"READY","verification_field":"DATE_OF_BIRTH","status_history":[{"user_id":null,"status":"DRAFT","timestamp":"2023-02-03T10:45:51.000Z"},{"user_id":"2ec7f1f9-add3-4e6d-9d14-bd8ac5e88872","status":"READY","timestamp":"2023-02-03T10:45:51.000Z"}],"file_name":"disbursement-february-03-2023.csv","created_at":"2023-02-03T10:45:51.000Z","updated_at":"2023-02-03T10:45:51.000Z","total_payments":10,"total_payments_sent":8,"total_payments_failed":1,"total_payments_remaining":1,"amount_disbursed":"800.00","total_amount":"1000.00","average_amount":"100.00"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Disbursements","description":"Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.","tags":["Disbursements"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"q","in":"query","description":"A search term used to query through the disbursement names.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Exact match on the status of the disbursement.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]}},{"name":"created_at_after","in":"query","description":"Only return disbursements that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return disbursements that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort disbursements","required":false,"schema":{"type":"string","enum":["name","created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting disbursements.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Disbursements","description":{"content":"Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.","type":"text/plain"},"url":{"path":["disbursements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"A search term used to query through the disbursement names.","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the disbursement.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Only return disbursements that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return disbursements that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort disbursements","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting disbursements.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List All Disbursements + + + +Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement. + +
                                                      Query Parameters
                                                      + +A list of Disbursement details + +
                                                      Schema
                                                        pagination object
                                                        data object[]
                                                      • Array [
                                                      • country object
                                                        wallet object
                                                        asset object
                                                        status_history object[]
                                                      • Array [
                                                      • ]
                                                      • ]
                                                      + +Unauthorized + +
                                                      Response Headers
                                                        Schema
                                                          extras object
                                                        + +Forbidden + +
                                                        Response Headers
                                                          Schema
                                                          diff --git a/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx b/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx new file mode 100644 index 000000000..6529cb2ec --- /dev/null +++ b/api/stellar-disbursement-platform/resources/list-all-payments.api.mdx @@ -0,0 +1,45 @@ +--- +id: list-all-payments +title: "List All Payments" +description: "Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information." +sidebar_label: "List All Payments" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"A paginated list of payments","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Payments","description":"Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.","tags":["Payments"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"status","in":"query","description":"Exact match on the status of the payment.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]}},{"name":"receiver_id","in":"query","description":"UUID that represents a receiver in the database","required":false,"example":"b6b667ad-6cc2-46cf-9be7-561daace7d48","schema":{"type":"string"}},{"name":"created_at_after","in":"query","description":"Only return payments that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return payments that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort payments","required":false,"schema":{"type":"string","enum":["created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting payments.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/payments","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Payments","description":{"content":"Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the payment.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"UUID that represents a receiver in the database","type":"text/plain"},"key":"receiver_id","value":""},{"disabled":false,"description":{"content":"Only return payments that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return payments that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort payments","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting payments.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List All Payments + + + +Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information. + +
                                                          Query Parameters
                                                          + +A paginated list of payments + +
                                                          Schema
                                                            pagination object
                                                            data object[]
                                                          • Array [
                                                          • status_history object[]
                                                          • Array [
                                                          • ]
                                                          • disbursement object
                                                            asset object
                                                            receiver_wallet object
                                                            receiver object
                                                            wallet object
                                                          • ]
                                                          + +Unauthorized + +
                                                          Response Headers
                                                            Schema
                                                              extras object
                                                            + +Forbidden + +
                                                            Response Headers
                                                              Schema
                                                              diff --git a/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx b/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx new file mode 100644 index 000000000..271d0e25f --- /dev/null +++ b/api/stellar-disbursement-platform/resources/list-all-receivers.api.mdx @@ -0,0 +1,45 @@ +--- +id: list-all-receivers +title: "List All Receivers" +description: "Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver." +sidebar_label: "List All Receivers" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"A paginated list of Receiver details","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","example":"?page=3&page_limit=2"},"prev":{"type":"string","example":"?page=1&page_limit=2"},"pages":{"type":"integer","example":8},"total":{"type":"integer","example":16}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"List All Receivers","description":"Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.","tags":["Receivers"],"parameters":[{"name":"page","in":"query","description":"The page requested.","required":false,"schema":{"type":"number","default":1}},{"name":"page_limit","in":"query","description":"Define how many results will be returned in the response.","required":false,"schema":{"type":"number","default":20}},{"name":"q","in":"query","description":"A search term used to query through the receiver phone_number, email, and ID.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Exact match on the status of the receiver wallet.","required":false,"example":"DRAFT","schema":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}},{"name":"created_at_after","in":"query","description":"Only return receivers that are created after this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"created_at_before","in":"query","description":"Only return receivers that are created before this date. Format: YYYY-MM-DD","required":false,"example":"2006-01-02","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Field used to sort receivers","required":false,"schema":{"type":"string","enum":["created_at"],"default":"created_at"}},{"name":"direction","in":"query","description":"Direction for sorting receivers.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/receivers","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"List All Receivers","description":{"content":"Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.","type":"text/plain"},"url":{"path":["receivers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The page requested.","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Define how many results will be returned in the response.","type":"text/plain"},"key":"page_limit","value":""},{"disabled":false,"description":{"content":"A search term used to query through the receiver phone_number, email, and ID.","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Exact match on the status of the receiver wallet.","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Only return receivers that are created after this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_after","value":""},{"disabled":false,"description":{"content":"Only return receivers that are created before this date. Format: YYYY-MM-DD","type":"text/plain"},"key":"created_at_before","value":""},{"disabled":false,"description":{"content":"Field used to sort receivers","type":"text/plain"},"key":"sort","value":""},{"disabled":false,"description":{"content":"Direction for sorting receivers.","type":"text/plain"},"key":"direction","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List All Receivers + + + +Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver. + +
                                                              Query Parameters
                                                              + +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 [
                                                              • ]
                                                              • ]
                                                              • ]
                                                              + +Unauthorized + +
                                                              Response Headers
                                                                Schema
                                                                  extras object
                                                                + +Forbidden + +
                                                                Response Headers
                                                                  Schema
                                                                  diff --git a/api/stellar-disbursement-platform/resources/log-in.api.mdx b/api/stellar-disbursement-platform/resources/log-in.api.mdx new file mode 100644 index 000000000..b8f382f11 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/log-in.api.mdx @@ -0,0 +1,41 @@ +--- +id: log-in +title: "Log In" +description: "Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols." +sidebar_label: "Log In" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Log In + + + +Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols. + +
                                                                  Request Body
                                                                  + +OK + +
                                                                  Response Headers
                                                                    Schema
                                                                    + +Bad Request + +
                                                                    Response Headers
                                                                      Schema
                                                                        extras object
                                                                      diff --git a/api/stellar-disbursement-platform/resources/organization/index.mdx b/api/stellar-disbursement-platform/resources/organization/index.mdx new file mode 100644 index 000000000..8c9412cb4 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/organization/index.mdx @@ -0,0 +1,24 @@ +--- +title: Organization +order: 2 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +Organization endpoints manage the process of getting and updating organizational profile information. The organization’s profile has basic information set at the time of SDP deployment. It can be modified by the Owner. Organizations can also manage their preferences, like which assets to use, through these endpoints. + + + +| | | +| --- | --------------------- | +| GET | [/organization](../get-organization-info.api.mdx) | +| PATCH | [/organization](../update-organization-profile.api.mdx) | +| GET | [/organization/logo](../get-organization-logo.api.mdx) | +| GET | [/countries](../get-all-countries.api.mdx) | +| GET | [/assets](../get-all-assets.api.mdx) | +| POST | [/assets](../create-asset.api.mdx) | +| DELETE | [/assets/:id](../delete-asset.api.mdx) | +| PATCH | [/assets/:id](../update-asset.api.mdx) | +| GET | [/wallets](../get-all-wallets.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/payments/index.mdx b/api/stellar-disbursement-platform/resources/payments/index.mdx new file mode 100644 index 000000000..04b8625c0 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/payments/index.mdx @@ -0,0 +1,17 @@ +--- +title: Payments +order: 3 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +An SDP payment is an individual payment from an organization to a receiver. Each payment is part of a disbursement and occurs on the Stellar network. Granular payment status is stored in the SDP database and can be viewed in real-time on the SDP dashboard. There is no POST endpoint because submitting payments to the Stellar network is handled by the Transaction Submission Service (TSS). + + + +| | | +| --- | --------------------- | +| GET | [/payments](../list-all-payments.api.mdx) | +| GET | [/payments/:id](../retrieve-a-payment.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/profile/index.mdx b/api/stellar-disbursement-platform/resources/profile/index.mdx new file mode 100644 index 000000000..d5343be42 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/profile/index.mdx @@ -0,0 +1,17 @@ +--- +title: Profile +order: 4 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +Profiles endpoints manage the process of getting and updating individual profile information. Profile information is set when the account is created and can be updated by the user on the SDP dashboard Profile page. Note: profiles never refer to receivers of funds. + + + +| | | +| --- | --------------------- | +| GET | [/profile](../get-profile.api.mdx) | +| PATCH | [/profile](../update-user-profile.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx b/api/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx new file mode 100644 index 000000000..543452116 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/provide-signed-challenge-transaction.api.mdx @@ -0,0 +1,41 @@ +--- +id: provide-signed-challenge-transaction +title: "Provide Signed Challenge Transaction" +description: "Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable." +sidebar_label: "Provide Signed Challenge Transaction" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"SEP-10 handshake was successful.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"The provided transaction is not valid"}},"examples":{"response":{"value":{"error":"The provided transaction is not valid"}}}}}}},"operationId":"Provide Signed Challenge Transaction","description":"Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable.","tags":["Registration"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"string"}},"example":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ=="}}}}},"method":"post","path":"/WEB_AUTH_ENDPOINT","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ=="},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Signed Challenge Transaction","description":{"content":"Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable.","type":"text/plain"},"url":{"path":["WEB_AUTH_ENDPOINT"],"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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Provide Signed Challenge Transaction + + + +Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable. + +
                                                                      Request Body
                                                                      + +SEP-10 handshake was successful. + +
                                                                      Response Headers
                                                                        Schema
                                                                        + +Unauthorized + +
                                                                        Response Headers
                                                                          Schema
                                                                          diff --git a/api/stellar-disbursement-platform/resources/receivers/index.mdx b/api/stellar-disbursement-platform/resources/receivers/index.mdx new file mode 100644 index 000000000..98906d21d --- /dev/null +++ b/api/stellar-disbursement-platform/resources/receivers/index.mdx @@ -0,0 +1,20 @@ +--- +title: Receivers +order: 5 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +A receiver is an individual receiving a payment in a disbursement. The receiver is tracked by phone number to reduce the need for personally identifiable information. Each receiver must be unique within the disbursement. + +Each receiver will have at least one wallet associated with them. The wallet public key will remain null until the receiver registers with a wallet provider and links the wallet to the SDP through SEP-24. Receivers must verify their identity through that process, which requires the SDP to store verification information on receivers like date of birth, national ID number, or personal PIN. This information can be updated by the organization through the receiver endpoints. + + + +| | | +| --- | --------------------- | +| GET | [/receivers](../list-all-receivers.api.mdx) | +| GET | [/receivers/:id](../retrieve-a-receiver.api.mdx) | +| PATCH | [/receivers/:id](../update-a-receiver.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/refresh-token.api.mdx b/api/stellar-disbursement-platform/resources/refresh-token.api.mdx new file mode 100644 index 000000000..09a497651 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/refresh-token.api.mdx @@ -0,0 +1,45 @@ +--- +id: refresh-token +title: "Refresh Token" +description: "A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires." +sidebar_label: "Refresh Token" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Returns a new access token","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"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"}}}}}}}},"operationId":"Refresh Token","description":"A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.","tags":["Authentication"],"security":[{"BearerAuth":[]}],"method":"post","path":"/refresh-token","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Refresh Token","description":{"content":"A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.","type":"text/plain"},"url":{"path":["refresh-token"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Refresh Token + + + +A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires. + +
                                                                          + +Returns a new access token + +
                                                                          Response Headers
                                                                            Schema
                                                                            + +Bad Request + +
                                                                            Schema
                                                                            + +Unauthorized + +
                                                                            Response Headers
                                                                              Schema
                                                                                extras object
                                                                              diff --git a/api/stellar-disbursement-platform/resources/registration/index.mdx b/api/stellar-disbursement-platform/resources/registration/index.mdx new file mode 100644 index 000000000..997c75f58 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/registration/index.mdx @@ -0,0 +1,35 @@ +--- +title: Registration +order: 6 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + + +The registration endpoints guide the process for a receiver to verify their identity and link their wallet address to an SDP. The registration process only needs to happen once per receiver to link their wallet. Only SDP-compatible wallet providers can facilitate the registration process. These endpoints must be supported and hit by the wallet providers after the receiver gets the initial SMS invite. After the wallet address is successfully linked, the payment automatically begins. + +There are two parts to the registration flow. First, the wallet must authenticate and initiate a registration flow using the Anchor Platform Endpoints defined below. Note that these endpoints are hosted on a different host than the Stellar Disursement Platform. + +The second part of the registration flow is handled by the webview that is opened within the wallet application. This webview uses the endpoints defined in the Stellar Disbursement Platfrom Endpoints section to complete the registration process. The wallet application can chose not to use the webview and intstead integrate directly with the API. + + + + +| | | +| --- | --------------------- | +| GET | [/.well-known/stellar.toml](../retrieve-stellar-info-file.api.mdx) | +| GET | [WEB_AUTH_ENDPOINT](../request-challenge-transaction.api.mdx) | +| POST | [WEB_AUTH_ENDPOINT](../provide-signed-challenge-transaction.api.mdx) | +| POST | [TRANSFER_SERVER_SEP0024/transactions/deposit/interactive](../request-registration-url.api.mdx) | + + + + + +| | | +| --- | --------------------- | +| GET | [/wallet-registration/start](../start-wallet-registration.api.mdx) | +| POST | [/wallet-registration/otp](../send-one-time-passcode.api.mdx) | +| POST | [/wallet-registration/verification](../verify-receiver-registration.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx b/api/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx new file mode 100644 index 000000000..7c8b2f105 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/request-challenge-transaction.api.mdx @@ -0,0 +1,41 @@ +--- +id: request-challenge-transaction +title: "Request Challenge Transaction" +description: "Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable." +sidebar_label: "Request Challenge Transaction" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"string"},"network_passphrase":{"type":"string"}},"example":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag==","network_passphrase":"Test SDF Network ; September 2015"}},"examples":{"response":{"value":{"transaction":"AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag==","network_passphrase":"Test SDF Network ; September 2015"}}}}}},"400":{"description":"If some information was missing or invalid.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"account":{"type":"string"}}}},"example":{"error":"Bad request.","extras":{"account":"account cannot be empty"}}},"examples":{"response":{"value":{"error":"Bad request.","extras":{"account":"account cannot be empty"}}}}}}}},"operationId":"Request Challenge Transaction","description":"Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable.","tags":["Registration"],"parameters":[{"name":"account","in":"query","description":"The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server..","required":true,"schema":{"type":"string"}},{"name":"memo","in":"query","description":"The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported.","required":false,"schema":{"type":"string"}},{"name":"client_domain","in":"query","description":"a Client Domain. Need to be supplied by all Clients/Wallets.","required":true,"schema":{"type":"string"}}],"method":"get","path":"/WEB_AUTH_ENDPOINT","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Request Challenge Transaction","description":{"content":"Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable.","type":"text/plain"},"url":{"path":["WEB_AUTH_ENDPOINT"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server..","type":"text/plain"},"key":"account","value":""},{"disabled":false,"description":{"content":"The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported.","type":"text/plain"},"key":"memo","value":""},{"disabled":false,"description":{"content":"(Required) a Client Domain. Need to be supplied by all Clients/Wallets.","type":"text/plain"},"key":"client_domain","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Request Challenge Transaction + + + +Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable. + +
                                                                              Query Parameters
                                                                              + +OK + +
                                                                              Response Headers
                                                                                Schema
                                                                                + +If some information was missing or invalid. + +
                                                                                Response Headers
                                                                                  Schema
                                                                                    extras object
                                                                                  diff --git a/api/stellar-disbursement-platform/resources/request-registration-url.api.mdx b/api/stellar-disbursement-platform/resources/request-registration-url.api.mdx new file mode 100644 index 000000000..f30946652 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/request-registration-url.api.mdx @@ -0,0 +1,39 @@ +--- +id: request-registration-url +title: "Request Registration URL" +description: "The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit." +sidebar_label: "Request Registration URL" +hide_title: true +hide_table_of_contents: true +api: {"description":"The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. \nIt also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).\n","externalDocs":{"description":"Find more info here","url":"https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2"},"tags":["Registration"],"responses":{"200":{"description":"An anchor requires the user to fill out information on a webpage hosted by the anchor.","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Always set to interactive_customer_info_needed.","example":"interactive_customer_info_needed"},"url":{"type":"string","description":"URL hosted by the anchor. The wallet should show this URL to the user as a popup.","example":"https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI"},"id":{"type":"string","description":"The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request.","example":"82fhs729f63dh0v4"}}}}}}},"method":"post","path":"/TRANSFER_SERVER_SEP0024/transactions/deposit/interactive","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Request Registration URL","description":{"content":"The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. \nIt also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).\n","type":"text/plain"},"url":{"path":["TRANSFER_SERVER_SEP0024","transactions","deposit","interactive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Request Registration URL + + + +The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. +It also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2). + + +
                                                                                  + +An anchor requires the user to fill out information on a webpage hosted by the anchor. + +
                                                                                  Schema
                                                                                  diff --git a/api/stellar-disbursement-platform/resources/reset-password.api.mdx b/api/stellar-disbursement-platform/resources/reset-password.api.mdx new file mode 100644 index 000000000..c52a3c181 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/reset-password.api.mdx @@ -0,0 +1,45 @@ +--- +id: reset-password +title: "Reset Rassword" +description: "Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email." +sidebar_label: "Reset Rassword" +hide_title: true +hide_table_of_contents: true +api: {"description":"Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.","operationId":"resetPassword","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New password for the user"},"reset_token":{"type":"string","description":"Token used to identify a valid password reset request"}},"required":["password","reset_token"]}}},"description":"Reset password request data","required":true},"responses":{"200":{"description":"Password reset successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}}},"method":"post","path":"/reset-password","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"password":"string","reset_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Reset Rassword","description":{"content":"Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.","type":"text/plain"},"url":{"path":["reset-password"],"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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reset Rassword + + + +Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email. + +
                                                                                  Request Body required
                                                                                  + +Reset password request data + +
                                                                                  + +Password reset successfully + +
                                                                                  + +Bad Request + +
                                                                                  Schema
                                                                                  diff --git a/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx new file mode 100644 index 000000000..5f2301c45 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/retrieve-a-disbursement.api.mdx @@ -0,0 +1,49 @@ +--- +id: retrieve-a-disbursement +title: "Retrieve a Disbursement" +description: "Fetches information on a specific disbursement by ```id```." +sidebar_label: "Retrieve a Disbursement" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Disbursement details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the disbursement","example":"619da857-8725-4c58-933d-c120a458e0f5"},"name":{"type":"string","description":"The name of the disbursement","example":"Disbursement Name"},"country":{"type":"object","properties":{"code":{"type":"string","description":"Country code in ISO 3166 alpha-3","example":"UKR"},"name":{"type":"string","description":"Country name","example":"Ukraine"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"},"sep_10_client_domain":{"type":"string","example":"api-dev.vibrantapp.com"},"deep_link_schema":{"type":"string","example":"https://vibrantapp.com/sdp-dev"},"created_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-07-31T20:50:45.648Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"status":{"description":"The status of the disbursement","example":"READY","type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"verification_field":{"example":"DATE_OF_BIRTH","type":"string","enum":["DATE_OF_BIRTH","PIN","NATIONAL_ID_NUMBER"]},"status_history":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"3f351b9e-ed0f-40fa-a314-14757b42dab1"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"file_name":{"type":"string","example":"disbursement-feb-03-2023.csv"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"integer","description":"Total number of payments","example":10},"total_payments_sent":{"type":"integer","description":"Total number of successful payments","example":8},"total_payments_failed":{"type":"integer","description":"Total number of failed payments","example":1},"total_payments_remaining":{"type":"integer","description":"Total number of remaining payments","example":1},"amount_disbursed":{"type":"string","description":"The total amount disbursed so far","example":"800.00"},"total_amount":{"type":"string","description":"The total amount to be disbursed","example":"1000.00"},"average_amount":{"type":"string","description":"The average amount per payment","example":"100.00"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Retrieve a Disbursement","description":"Fetches information on a specific disbursement by ```id```.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the `Disbursement`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/disbursements/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Disbursement","description":{"content":"Fetches information on a specific disbursement by ```id```.","type":"text/plain"},"url":{"path":["disbursements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Disbursement`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve a Disbursement + + + +Fetches information on a specific disbursement by ```id```. + +
                                                                                  Path Parameters
                                                                                  + +Disbursement details + +
                                                                                  Schema
                                                                                    country object
                                                                                    wallet object
                                                                                    asset object
                                                                                    status_history object[]
                                                                                  • Array [
                                                                                  • ]
                                                                                  + +Unauthorized + +
                                                                                  Response Headers
                                                                                    Schema
                                                                                      extras object
                                                                                    + +Forbidden + +
                                                                                    Response Headers
                                                                                      Schema
                                                                                      + +Not Found + +
                                                                                      Response Headers
                                                                                        Schema
                                                                                          extras object
                                                                                        diff --git a/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx new file mode 100644 index 000000000..fa8c2b83b --- /dev/null +++ b/api/stellar-disbursement-platform/resources/retrieve-a-payment.api.mdx @@ -0,0 +1,49 @@ +--- +id: retrieve-a-payment +title: "Retrieve a Payment" +description: "Fetches detailed information on a specific payment by ```id```." +sidebar_label: "Retrieve a Payment" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Payment details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ddf22f55-3259-4822-a4e2-ce01334997f4"},"amount":{"type":"string","example":"100.00"},"stellar_transaction_id":{"type":"string","example":"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"},"stellar_operation_id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","PENDING","PAUSED","SUCCESS","FAILED"]},"status_message":{"type":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}},"disbursement":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the disbursement","example":"c51ba1d5-52d3-412f-a59c-6ef32d59ab43"},"name":{"type":"string","description":"The name of the disbursement","example":"disbursement-june-29"},"status":{"type":"string","enum":["DRAFT","READY","STARTED","PAUSED","COMPLETED"]},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the disbursement","example":"2023-06-30T01:22:57.831975Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update timestamp of the disbursement","example":"2023-06-30T01:22:58.316511Z"}}},"asset":{"type":"object","properties":{"id":{"type":"string","example":"ffaec4b3-46b0-4db4-a4c4-6c3508057705"},"code":{"type":"string","description":"Asset code","example":"USDC"},"issuer":{"type":"string","description":"Asset issuer address","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"deleted_at":{"type":"string","format":"date-time","example":"2023-06-03T10:55:51.000Z"}}},"receiver_wallet":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]}}},"created_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2023-02-03T10:45:51.000Z"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Payment not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Payment not found"}}}}}}}},"operationId":"Retrieve a Payment","description":"Fetches detailed information on a specific payment by ```id```.","tags":["Payments"],"parameters":[{"name":"id","in":"path","description":"ID of the `Payment`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/payments/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Payment","description":{"content":"Fetches detailed information on a specific payment by ```id```.","type":"text/plain"},"url":{"path":["payments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Payment`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve a Payment + + + +Fetches detailed information on a specific payment by ```id```. + +
                                                                                        Path Parameters
                                                                                        + +Payment details + +
                                                                                        Schema
                                                                                          status_history object[]
                                                                                        • Array [
                                                                                        • ]
                                                                                        • disbursement object
                                                                                          asset object
                                                                                          receiver_wallet object
                                                                                          receiver object
                                                                                          wallet object
                                                                                        + +Unauthorized + +
                                                                                        Response Headers
                                                                                          Schema
                                                                                            extras object
                                                                                          + +Forbidden + +
                                                                                          Response Headers
                                                                                            Schema
                                                                                            + +Not Found + +
                                                                                            Response Headers
                                                                                              Schema
                                                                                                extras object
                                                                                              diff --git a/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx new file mode 100644 index 000000000..e53b96962 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/retrieve-a-receiver.api.mdx @@ -0,0 +1,49 @@ +--- +id: retrieve-a-receiver +title: "Retrieve a Receiver" +description: "Fetches detailed information on a specific receiver by ```id```, including all associated wallets." +sidebar_label: "Retrieve a Receiver" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Receiver Details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Resource not found"}}}}}}}},"operationId":"Retrieve a Receiver","description":"Fetches detailed information on a specific receiver by ```id```, including all associated wallets.","tags":["Receivers"],"parameters":[{"name":"id","in":"path","description":"ID of the `Receiver`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/receivers/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve a Receiver","description":{"content":"Fetches detailed information on a specific receiver by ```id```, including all associated wallets.","type":"text/plain"},"url":{"path":["receivers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Receiver`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve a Receiver + + + +Fetches detailed information on a specific receiver by ```id```, including all associated wallets. + +
                                                                                              Path Parameters
                                                                                              + +Receiver Details + +
                                                                                              Schema
                                                                                                received_amounts object[]
                                                                                              • Array [
                                                                                              • ]
                                                                                              • wallets object[]
                                                                                              • Array [
                                                                                              • receiver object
                                                                                                wallet object
                                                                                                received_amounts object[]
                                                                                              • Array [
                                                                                              • ]
                                                                                              • status_history object[]
                                                                                              • Array [
                                                                                              • ]
                                                                                              • ]
                                                                                              + +Unauthorized + +
                                                                                              Response Headers
                                                                                                Schema
                                                                                                  extras object
                                                                                                + +Forbidden + +
                                                                                                Response Headers
                                                                                                  Schema
                                                                                                  + +Not Found + +
                                                                                                  Response Headers
                                                                                                    Schema
                                                                                                      extras object
                                                                                                    diff --git a/api/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx new file mode 100644 index 000000000..f6fd1df17 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/retrieve-all-statistics.api.mdx @@ -0,0 +1,41 @@ +--- +id: retrieve-all-statistics +title: "Retrieve All Statistics" +description: "Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets." +sidebar_label: "Retrieve All Statistics" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"General Statistics response","content":{"application/json":{"schema":{"type":"object","properties":{"total_disbursements":{"type":"integer","description":"Total number of disbursements","format":"int64","example":20},"payment_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":2},"pending":{"type":"integer","format":"int64","example":3},"paused":{"type":"integer","format":"int64","example":1},"success":{"type":"integer","format":"int64","example":5},"failed":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":14}}},"payment_amounts_by_asset":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"payment_amounts":{"type":"object","properties":{"draft":{"type":"string","example":"100.00"},"ready":{"type":"string","example":"200.00"},"pending":{"type":"string","example":"300.00"},"paused":{"type":"string","example":"100.00"},"success":{"type":"string","example":"500.00"},"failed":{"type":"string","example":"100.00"},"average":{"type":"string","example":"100.00"},"total":{"type":"string","example":"1400.00"}}}}}},"receiver_wallets_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":1},"registered":{"type":"integer","format":"int64","example":1},"flagged":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":4}}},"total_receivers":{"type":"integer","description":"Total number of receivers","format":"int64","example":1000}}}}}},"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"}}}}}}}},"operationId":"Retrieve All Statistics","description":"Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.","tags":["Statistics"],"security":[{"BearerAuth":[]}],"method":"get","path":"/statistics","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve All Statistics","description":{"content":"Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.","type":"text/plain"},"url":{"path":["statistics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve All Statistics + + + +Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets. + +
                                                                                                    + +General Statistics response + +
                                                                                                    Schema
                                                                                                      payment_counters object
                                                                                                      payment_amounts_by_asset object[]
                                                                                                    • Array [
                                                                                                    • payment_amounts object
                                                                                                    • ]
                                                                                                    • receiver_wallets_counters object
                                                                                                    + +Unauthorized + +
                                                                                                    Response Headers
                                                                                                      Schema
                                                                                                        extras object
                                                                                                      diff --git a/api/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx new file mode 100644 index 000000000..532b19d64 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/retrieve-disbursement-statistics.api.mdx @@ -0,0 +1,45 @@ +--- +id: retrieve-disbursement-statistics +title: "Retrieve Disbursement Statistics" +description: "Fetches metrics on a specific disbursement by ```id```." +sidebar_label: "Retrieve Disbursement Statistics" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Returns statistics for disbursement","content":{"application/json":{"schema":{"type":"object","properties":{"payment_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":2},"pending":{"type":"integer","format":"int64","example":3},"paused":{"type":"integer","format":"int64","example":1},"success":{"type":"integer","format":"int64","example":5},"failed":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":14}}},"payment_amounts_by_asset":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"payment_amounts":{"type":"object","properties":{"draft":{"type":"string","example":"100.00"},"ready":{"type":"string","example":"200.00"},"pending":{"type":"string","example":"300.00"},"paused":{"type":"string","example":"100.00"},"success":{"type":"string","example":"500.00"},"failed":{"type":"string","example":"100.00"},"average":{"type":"string","example":"100.00"},"total":{"type":"string","example":"1400.00"}}}}}},"receiver_wallets_counters":{"type":"object","properties":{"draft":{"type":"integer","format":"int64","example":1},"ready":{"type":"integer","format":"int64","example":1},"registered":{"type":"integer","format":"int64","example":1},"flagged":{"type":"integer","format":"int64","example":1},"total":{"type":"integer","format":"int64","example":4}}},"total_receivers":{"type":"integer","description":"Total number of receivers","format":"int64","example":100}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Retrieve Disbursement Statistics","description":"Fetches metrics on a specific disbursement by ```id```.","tags":["Statistics"],"parameters":[{"name":"id","in":"path","description":"ID of the `Disbursement`.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"get","path":"/statistics/disbursements/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Disbursement Statistics","description":{"content":"Fetches metrics on a specific disbursement by ```id```.","type":"text/plain"},"url":{"path":["statistics","disbursements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Disbursement`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve Disbursement Statistics + + + +Fetches metrics on a specific disbursement by ```id```. + +
                                                                                                      Path Parameters
                                                                                                      + +Returns statistics for disbursement + +
                                                                                                      Schema
                                                                                                        payment_counters object
                                                                                                        payment_amounts_by_asset object[]
                                                                                                      • Array [
                                                                                                      • payment_amounts object
                                                                                                      • ]
                                                                                                      • receiver_wallets_counters object
                                                                                                      + +Unauthorized + +
                                                                                                      Response Headers
                                                                                                        Schema
                                                                                                          extras object
                                                                                                        + +Forbidden + +
                                                                                                        Response Headers
                                                                                                          Schema
                                                                                                          diff --git a/api/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx b/api/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx new file mode 100644 index 000000000..57bfb12d7 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/retrieve-stellar-info-file.api.mdx @@ -0,0 +1,37 @@ +--- +id: retrieve-stellar-info-file +title: "Retrieve Stellar Info File" +description: "Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url." +sidebar_label: "Retrieve Stellar Info File" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Token is valid and the webpage will be loaded normally.","headers":{},"content":{"text/toml":{"examples":{"response":{"value":"ACCOUNTS=[\"GBC2HVWFIFN7WJHFORVBCDKJORXXXXXXXXXXXXXXXXXXXXXXXX\", \"GDA34JZ26FZY64XCSY46CUNSHLX762LHJXQXXXXXXXXXXXXXXXXXXXXXXXX\"] SIGNING_KEY=\"GDA34JZ26FZY64XCSY46XXXXXXXXXXXXXXXXXXXXXXXX\" NETWORK_PASSPHRASE=\"Test SDF Network ; September 2015\" HORIZON_URL=\"https://horizon-testnet.stellar.org\" WEB_AUTH_ENDPOINT=\"https://ap-stellar-disbursement-platform-backend-dev.stellar.org/auth\" TRANSFER_SERVER_SEP0024=\"https://ap-stellar-disbursement-platform-backend-dev.stellar.org/sep24\"\n[[DOCUMENTATION]] ORG_NAME=\"Stellar Aid\"\n[[CURRENCIES]] code = \"EUROC\" issuer = \"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5\" is_asset_anchored = true anchor_asset_type = \"fiat\" status = \"live\" desc = \"EUROC\"\n[[CURRENCIES]] code = \"USDC\" issuer = \"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5\" is_asset_anchored = true anchor_asset_type = \"fiat\" status = \"live\" desc = \"USDC\"\n"}}}}}},"operationId":"Retrieve Stellar Info File","description":"Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.","tags":["Registration"],"method":"get","path":"/.well-known/stellar.toml","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Retrieve Stellar Info File","description":{"content":"Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.","type":"text/plain"},"url":{"path":[".well-known","stellar.toml"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/toml"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve Stellar Info File + + + +Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url. + +
                                                                                                          + +Token is valid and the webpage will be loaded normally. + +
                                                                                                          Response Headers
                                                                                                            Schema
                                                                                                              any
                                                                                                            diff --git a/api/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx b/api/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx new file mode 100644 index 000000000..21e68e578 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/send-one-time-passcode.api.mdx @@ -0,0 +1,53 @@ +--- +id: send-one-time-passcode +title: "Send One-Time Passcode" +description: "This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request." +sidebar_label: "Send One-Time Passcode" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"Send One-Time Passcode","description":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). 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"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation"}},"required":["phone_number","recaptcha_token"]}}},"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 authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"phone_number":"string","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Send One-Time Passcode","description":{"content":"This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). 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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Send One-Time Passcode + + + +This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request. + +
                                                                                                            Header Parameters
                                                                                                            Request Body required
                                                                                                            + +Object containing phone number + +
                                                                                                            + +OTP sent successfully + +
                                                                                                            Schema
                                                                                                            + +Bad Request + +
                                                                                                            Schema
                                                                                                            + +Unauthorized + +
                                                                                                            Response Headers
                                                                                                              Schema
                                                                                                                extras object
                                                                                                              + +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. + +
                                                                                                              Schema
                                                                                                                extras object
                                                                                                              diff --git a/api/stellar-disbursement-platform/resources/sidebar.js b/api/stellar-disbursement-platform/resources/sidebar.js new file mode 100644 index 000000000..55eef64c6 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/sidebar.js @@ -0,0 +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":"Provide Multi-Factor Authentication","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/forgot-password","label":"Forgot Password","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/reset-password","label":"Reset Rassword","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-disbursement","label":"Create Disbursement","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-a-receiver","label":"Update a 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-statistics","label":"Retrieve Disbursement Statistics","className":"api-method get"}]},{"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/start-wallet-registration","label":"Start Wallet Registration","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/send-one-time-passcode","label":"Send One-Time Passcode","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/verify-receiver-registration","label":"Verify Receiver Registration","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/retrieve-stellar-info-file","label":"Retrieve Stellar Info File","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/request-challenge-transaction","label":"Request Challenge Transaction","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/provide-signed-challenge-transaction","label":"Provide Signed Challenge Transaction","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/request-registration-url","label":"Request Registration URL","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/update-user-profile","label":"Update User Profile","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/update-organization-profile","label":"Update 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-all-countries","label":"Get All Countries","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-all-assets","label":"Get All Assets","className":"api-method get"},{"type":"doc","id":"stellar-disbursement-platform/resources/create-asset","label":"Create Asset","className":"api-method post"},{"type":"doc","id":"stellar-disbursement-platform/resources/delete-asset","label":"Delete Asset","className":"api-method delete"},{"type":"doc","id":"stellar-disbursement-platform/resources/update-asset","label":"Update Asset","className":"api-method patch"},{"type":"doc","id":"stellar-disbursement-platform/resources/get-all-wallets","label":"Get All Wallets","className":"api-method get"}]},{"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/update-user-activation-status","label":"Update User Activation Status","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/update-user-role","label":"Update User Role","className":"api-method patch"}]}]; \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx b/api/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx new file mode 100644 index 000000000..4cf83b8f9 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/start-wallet-registration.api.mdx @@ -0,0 +1,49 @@ +--- +id: start-wallet-registration +title: "Start Wallet Registration" +description: "This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request." +sidebar_label: "Start Wallet Registration" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"Start Wallet Registration","description":"This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. 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 authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Start Wallet Registration","description":{"content":"This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. 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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Start Wallet Registration + + + +This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request. + +
                                                                                                              Query Parameters
                                                                                                              + +Token is valid and the webpage will be loaded normally. + +
                                                                                                              Schema
                                                                                                              • string
                                                                                                                + +HTML page content + +
                                                                                                              + +Bad Request + +
                                                                                                              Schema
                                                                                                              + +Unauthorized + +
                                                                                                              Response Headers
                                                                                                                Schema
                                                                                                                  extras object
                                                                                                                Schema
                                                                                                                  any
                                                                                                                diff --git a/api/stellar-disbursement-platform/resources/statistics/index.mdx b/api/stellar-disbursement-platform/resources/statistics/index.mdx new file mode 100644 index 000000000..727961f2b --- /dev/null +++ b/api/stellar-disbursement-platform/resources/statistics/index.mdx @@ -0,0 +1,15 @@ +--- +title: Statistics +order: 7 +--- + +Statistics endpoints return general aggregated data per organization, as well as disbursement-specific metrics. SDP users can use this data to monitor their disbursements over time. + + + +| | | +| --- | --------------------- | +| GET | [/statistics](../retrieve-all-statistics.api.mdx) | +| GET | [/statistics/disbursements/:id](../retrieve-disbursement-statistics.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx b/api/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx new file mode 100644 index 000000000..1154bc82f --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-a-disbursement-status.api.mdx @@ -0,0 +1,53 @@ +--- +id: update-a-disbursement-status +title: "Update a Disbursement Status" +description: "Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready." +sidebar_label: "Update a Disbursement Status" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Message Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"Disbursement started"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Bad request","extras":{"status":400,"message":"Disbursement is not ready to be started"}}},"examples":{"response":{"value":{"error":"Bad request","extras":{"status":400,"message":"Disbursement is not ready to be started"}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Update a Disbursement Status","description":"Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the disbursement","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"method":"patch","path":"/disbursements/{id}/status","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update a Disbursement Status","description":{"content":"Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.","type":"text/plain"},"url":{"path":["disbursements",":id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Disbursement Status + + + +Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready. + +
                                                                                                                Path Parameters
                                                                                                                + +Message Response + +
                                                                                                                Schema
                                                                                                                + +Bad Request + +
                                                                                                                Response Headers
                                                                                                                  Schema
                                                                                                                    extras object
                                                                                                                  + +Unauthorized + +
                                                                                                                  Response Headers
                                                                                                                    Schema
                                                                                                                      extras object
                                                                                                                    + +Forbidden + +
                                                                                                                    Response Headers
                                                                                                                      Schema
                                                                                                                      + +Not Found + +
                                                                                                                      Response Headers
                                                                                                                        Schema
                                                                                                                          extras object
                                                                                                                        diff --git a/api/stellar-disbursement-platform/resources/update-a-receiver.api.mdx b/api/stellar-disbursement-platform/resources/update-a-receiver.api.mdx new file mode 100644 index 000000000..410ee8c38 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-a-receiver.api.mdx @@ -0,0 +1,57 @@ +--- +id: update-a-receiver +title: "Update a Receiver" +description: "This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver." +sidebar_label: "Update a Receiver" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Updated Receiver Details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"f83bb638-dda4-41e6-80c9-d03e6eec2aef"},"phone_number":{"type":"string","example":"+15552368475"},"external_id":{"type":"string","example":"usr12334"},"email":{"type":"string","example":"jdoe@mail.org"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"total_payments":{"type":"string","example":"2"},"successful_payments":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"registered_wallets":{"type":"string","example":1},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"803031d4-1d04-4879-b6d9-dc5641f9988e"},"receiver":{"type":"object","properties":{"id":{"type":"string","example":"029e2ed0-feb6-4c40-8b47-0836a85741a2"}}},"wallet":{"type":"object","properties":{"id":{"type":"string","example":"5ada9ed5-455a-4782-a0ee-160767e0deb1"},"name":{"type":"string","example":"Vibrant Assist"},"homepage":{"type":"string","example":"https://vibrantapp.com"}}},"stellar_address":{"type":"string","example":"GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"},"stellar_memo":{"type":"string"},"stellar_memo_type":{"type":"string"},"created_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"updated_at":{"type":"string","example":"2023-02-03T10:45:51.000Z"},"invited_at":{"type":"string","example":"2023-02-09T10:45:51.000Z"},"last_sms_sent":{"type":"string","example":"2023-02-10T10:45:51.000Z","description":"timestamp when the receiver last received an SMS about this wallet"},"total_payments":{"type":"string","example":"2"},"payments_received":{"type":"string","example":"2"},"failed_payments":{"type":"string","example":"0"},"remaining_payments":{"type":"string","example":"0"},"received_amounts":{"type":"array","items":{"type":"object","properties":{"asset_code":{"type":"string","example":"USDC"},"asset_issuer":{"type":"string","example":"GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"},"received_amount":{"type":"string","example":"100.00"}}}},"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"status_history":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","READY","REGISTERED","FLAGGED"]},"timestamp":{"type":"string","format":"date-time","example":"2023-02-10T10:45:51.000Z"}}}}}}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Resource not found"}}}}}}}},"operationId":"Update a Receiver","description":"This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.","tags":["Receivers"],"parameters":[{"name":"id","in":"path","description":"ID of the `Receiver`.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"date_of_birth":{"type":"string","description":"Date of birth of the receiver"},"pin":{"type":"string","description":"Personal identification number of the receiver"},"national_id":{"type":"string","description":"National ID of the receiver"},"email":{"type":"string","description":"Email of the receiver"},"external_id":{"type":"string","description":"External ID of the receiver"}},"example":{"date_of_birth":"1980-01-01","pin":"1234","national_id":"123456789","email":"john@example.com","external_id":"external123"}}}},"description":"List of fields to patch for the receiver","required":true},"security":[{"BearerAuth":[]}],"method":"patch","path":"/receivers/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"date_of_birth":"1980-01-01","pin":"1234","national_id":"123456789","email":"john@example.com","external_id":"external123"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update a Receiver","description":{"content":"This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.","type":"text/plain"},"url":{"path":["receivers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the `Receiver`.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Receiver + + + +This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver. + +
                                                                                                                        Path Parameters
                                                                                                                        Request Body required
                                                                                                                        + +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 [
                                                                                                                        • ]
                                                                                                                        • ]
                                                                                                                        + +Bad Request + +
                                                                                                                        Schema
                                                                                                                        + +Unauthorized + +
                                                                                                                        Response Headers
                                                                                                                          Schema
                                                                                                                            extras object
                                                                                                                          + +Forbidden + +
                                                                                                                          Response Headers
                                                                                                                            Schema
                                                                                                                            + +Not Found + +
                                                                                                                            Response Headers
                                                                                                                              Schema
                                                                                                                                extras object
                                                                                                                              diff --git a/api/stellar-disbursement-platform/resources/update-asset.api.mdx b/api/stellar-disbursement-platform/resources/update-asset.api.mdx new file mode 100644 index 000000000..440650aba --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-asset.api.mdx @@ -0,0 +1,49 @@ +--- +id: update-asset +title: "Update Asset" +description: "This endpoint is used to update the metadata of an existing asset." +sidebar_label: "Update Asset" +hide_title: true +hide_table_of_contents: true +api: {"description":"This endpoint is used to update the metadata of an existing asset.","tags":["Organization"],"parameters":[{"name":"id","in":"path","description":"ID of the asset to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The asset code"},"issuer":{"type":"string","description":"The issuer"}},"required":["code","issuer"]}}},"description":"Asset metadata to be updated","required":true},"responses":{"200":{"description":"Asset updated successfully"},"400":{"description":"Bad request, invalid request body or the provided code/issuer is invalid"},"404":{"description":"Asset not found"}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/assets/{id}","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"code":"string","issuer":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update Asset","description":{"content":"This endpoint is used to update the metadata of an existing asset.","type":"text/plain"},"url":{"path":["assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the asset to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Asset + + + +This endpoint is used to update the metadata of an existing asset. + +
                                                                                                                              Path Parameters
                                                                                                                              Request Body required
                                                                                                                              + +Asset metadata to be updated + +
                                                                                                                              + +Asset updated successfully + +
                                                                                                                              + +Bad request, invalid request body or the provided code/issuer is invalid + +
                                                                                                                              + +Asset not found + +
                                                                                                                              diff --git a/api/stellar-disbursement-platform/resources/update-organization-profile.api.mdx b/api/stellar-disbursement-platform/resources/update-organization-profile.api.mdx new file mode 100644 index 000000000..2648f43cf --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-organization-profile.api.mdx @@ -0,0 +1,45 @@ +--- +id: update-organization-profile +title: "Update Organization Profile" +description: "Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client." +sidebar_label: "Update Organization Profile" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"organization profile updated successfully"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update Organization Profile","description":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","tags":["Organization"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"},"data":{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_workflow_enabled` (boolean): whether the approval workflow is enabled or not. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_workflow_enabled\": true}'\n","type":"string","format":"json"}}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update Organization Profile","description":{"content":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Organization Profile + + + +Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client. + +
                                                                                                                              Request Body
                                                                                                                              + +OK + +
                                                                                                                              Schema
                                                                                                                              + +Unauthorized + +
                                                                                                                              Response Headers
                                                                                                                                Schema
                                                                                                                                  extras object
                                                                                                                                + +Forbidden + +
                                                                                                                                Response Headers
                                                                                                                                  Schema
                                                                                                                                  diff --git a/api/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx b/api/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx new file mode 100644 index 000000000..7ab07f14a --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-user-activation-status.api.mdx @@ -0,0 +1,45 @@ +--- +id: update-user-activation-status +title: "Update User Activation Status" +description: "Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password." +sidebar_label: "Update User Activation Status" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"1736bed3-7b92-4760-8ff2-51fb08ee079f"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"}},"required":["id","first_name","last_name","email","roles","is_active"],"example":[{"id":"7a4c6555-1f73-49b3-a211-f95bd2b8ec90","first_name":"John","last_name":"Doe","email":"email@email.com","roles":["developer"],"is_active":true},{"id":"5f4df1dd-c84f-482a-84ad-541ffd46e75a","first_name":"Jane","last_name":"Doe","email":"email@email.com","roles":["financial_controller"],"is_active":false}]},"examples":{"response":{"value":{"message":"user activation was updated successfully"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Activation Status","description":"Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"is_active":{"type":"boolean"}},"example":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","is_active":false}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/users/activation","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","is_active":false},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Activation Status","description":{"content":"Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.","type":"text/plain"},"url":{"path":["users","activation"],"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"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update User Activation Status + + + +Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password. + +
                                                                                                                                  Request Body
                                                                                                                                  + +Created + +
                                                                                                                                  Schema
                                                                                                                                  + +Unauthorized + +
                                                                                                                                  Response Headers
                                                                                                                                    Schema
                                                                                                                                      extras object
                                                                                                                                    + +Forbidden + +
                                                                                                                                    Response Headers
                                                                                                                                      Schema
                                                                                                                                      diff --git a/api/stellar-disbursement-platform/resources/update-user-profile.api.mdx b/api/stellar-disbursement-platform/resources/update-user-profile.api.mdx new file mode 100644 index 000000000..bd0573611 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-user-profile.api.mdx @@ -0,0 +1,45 @@ +--- +id: update-user-profile +title: "Update User Profile" +description: "Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request." +sidebar_label: "Update User Profile" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"user profile updated successfully"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Profile","description":"Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.","tags":["Profile"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"}},"example":{"first_name":"FirstName","last_name":"LastName","email":"email@email.com","password":"mysecret"}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/profile","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"first_name":"FirstName","last_name":"LastName","email":"email@email.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Profile","description":{"content":"Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.","type":"text/plain"},"url":{"path":["profile"],"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"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update User Profile + + + +Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request. + +
                                                                                                                                      Request Body
                                                                                                                                      + +OK + +
                                                                                                                                      Response Headers
                                                                                                                                        Schema
                                                                                                                                        + +Unauthorized + +
                                                                                                                                        Response Headers
                                                                                                                                          Schema
                                                                                                                                            extras object
                                                                                                                                          + +Forbidden + +
                                                                                                                                          Response Headers
                                                                                                                                            Schema
                                                                                                                                            diff --git a/api/stellar-disbursement-platform/resources/update-user-role.api.mdx b/api/stellar-disbursement-platform/resources/update-user-role.api.mdx new file mode 100644 index 000000000..e8ec22357 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/update-user-role.api.mdx @@ -0,0 +1,45 @@ +--- +id: update-user-role +title: "Update User Role" +description: "Updates an SDP user’s role by ```user_ID```." +sidebar_label: "Update User Role" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"user roles were updated successfully"}},"examples":{"response":{"value":{"message":"user roles were updated successfully"}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update User Role","description":"Updates an SDP user’s role by ```user_ID```.","tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"example":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","roles":["developer"]}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/users/roles","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"user_id":"5ca230c9-da95-4bd1-b2a2-aa5d0df65efd","roles":["developer"]},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update User Role","description":{"content":"Updates an SDP user’s role by ```user_ID```.","type":"text/plain"},"url":{"path":["users","roles"],"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"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update User Role + + + +Updates an SDP user’s role by ```user_ID```. + +
                                                                                                                                            Request Body
                                                                                                                                            + +OK + +
                                                                                                                                            Response Headers
                                                                                                                                              Schema
                                                                                                                                              + +Unauthorized + +
                                                                                                                                              Response Headers
                                                                                                                                                Schema
                                                                                                                                                  extras object
                                                                                                                                                + +Forbidden + +
                                                                                                                                                Response Headers
                                                                                                                                                  Schema
                                                                                                                                                  diff --git a/api/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx b/api/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx new file mode 100644 index 000000000..b12b36c28 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/upload-disbursement-instructions.api.mdx @@ -0,0 +1,53 @@ +--- +id: upload-disbursement-instructions +title: "Upload Disbursement Instructions" +description: "Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called." +sidebar_label: "Upload Disbursement Instructions" +hide_title: true +hide_table_of_contents: true +api: {"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"File uploaded succesfully"}},"examples":{"response":{"value":{"message":"File uploaded succesfully"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"foo":{"type":"string"},"message":{"type":"string"}}}},"example":{"error":"Invalid file format *.xyz","extras":{"foo":"bar","message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Invalid file format *.xyz","extras":{"foo":"bar","message":"Not authorized"}}}}}}},"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"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}},"examples":{"response":{"value":{"error":"Not found","extras":{"status":404,"message":"Disbursement not found"}}}}}}}},"operationId":"Upload Disbursement Instructions","description":"Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.","tags":["Disbursements"],"parameters":[{"name":"id","in":"path","description":"ID of the Disbursement","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Disbursement instructions file to upload. The CSV file should be in the following format: `phone,id,amount,verification`","type":"string","format":"binary"}},"required":["file"]}}},"required":true},"security":[{"BearerAuth":[]}],"method":"post","path":"/disbursements/{id}/instructions","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Upload Disbursement Instructions","description":{"content":"Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.","type":"text/plain"},"url":{"path":["disbursements",":id","instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Disbursement","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Upload Disbursement Instructions + + + +Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called. + +
                                                                                                                                                  Path Parameters
                                                                                                                                                  Request Body required
                                                                                                                                                  + +Created + +
                                                                                                                                                  Response Headers
                                                                                                                                                    Schema
                                                                                                                                                    + +Bad Request + +
                                                                                                                                                    Response Headers
                                                                                                                                                      Schema
                                                                                                                                                        extras object
                                                                                                                                                      + +Unauthorized + +
                                                                                                                                                      Response Headers
                                                                                                                                                        Schema
                                                                                                                                                          extras object
                                                                                                                                                        + +Forbidden + +
                                                                                                                                                        Response Headers
                                                                                                                                                          Schema
                                                                                                                                                          + +Not Found + +
                                                                                                                                                          Response Headers
                                                                                                                                                            Schema
                                                                                                                                                              extras object
                                                                                                                                                            diff --git a/api/stellar-disbursement-platform/resources/users/index.mdx b/api/stellar-disbursement-platform/resources/users/index.mdx new file mode 100644 index 000000000..dc4f45092 --- /dev/null +++ b/api/stellar-disbursement-platform/resources/users/index.mdx @@ -0,0 +1,18 @@ +--- +title: Users +order: 8 +--- + +The users endpoints facilitate the creation of new SDP users–including setting the appropriate role, sending an email invitation, and activating a user–and managing roles. + + + +| | | +| --- | --------------------- | +| GET | [/users](../get-all-users.api.mdx) | +| POST | [/users](../create-user.api.mdx) | +| PATCH | [/users/activation](../update-user-activation-status.api.mdx) | +| GET | [/users/roles](../get-all-roles.api.mdx) | +| PATCH | [/users/roles](../update-user-role.api.mdx) | + + \ No newline at end of file diff --git a/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx b/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx new file mode 100644 index 000000000..4e74be84d --- /dev/null +++ b/api/stellar-disbursement-platform/resources/verify-receiver-registration.api.mdx @@ -0,0 +1,49 @@ +--- +id: verify-receiver-registration +title: "Verify Receiver Registration" +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." +sidebar_label: "Verify Receiver Registration" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"Verify Receiver Registration","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 authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"phone_number":"string","otp":"string","verification":"string","verification_type":"DATE_OF_BIRTH","recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"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 +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Verify Receiver Registration + + + +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. + +
                                                                                                                                                            Header Parameters
                                                                                                                                                            Request Body required
                                                                                                                                                            + +Verification data including phone number, OTP, verification value, and reCAPTCHA token + +
                                                                                                                                                            + +Verification successful + +
                                                                                                                                                            Schema
                                                                                                                                                            + +Bad Request + +
                                                                                                                                                            Schema
                                                                                                                                                            + +Unauthorized + +
                                                                                                                                                            Response Headers
                                                                                                                                                              Schema
                                                                                                                                                                extras object
                                                                                                                                                              diff --git a/docs/stellar-disbursement-platform/design-and-architecture.mdx b/docs/stellar-disbursement-platform/design-and-architecture.mdx index 480da9adb..02cad9dac 100644 --- a/docs/stellar-disbursement-platform/design-and-architecture.mdx +++ b/docs/stellar-disbursement-platform/design-and-architecture.mdx @@ -7,7 +7,7 @@ The Stellar Disbursement Platform consists of four services deployed together: - **Dashboard**: the user interface administrators use to initiate and track the progress of disbursements - **SDP Core Service**: the core backend service that performs several functions: - - **Dashboard API**: the API used by the front-end UI for all disbursement requests + - **Dashboard API**: the API used by the front-end UI for all disbursement requests. The API is documented [here](/api/stellar-disbursement-platform) - **Messaging Service**: a recurring process that sends text messages to users prompting them to download the wallet selected for a particular disbursement and verify their phone with an OTP - **Wallet Registration UI**: a web application that collects and verifies the recipient’s OTP code and verification information via Stellar’s [SEP-24: Hosted Deposit and Withdrawal](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md) protocol - **Anchor Platform Service**: the API server that the wallet uses to authenticate and initiate the recipient’s registration process through the SEP-24 deposit flow diff --git a/docusaurus.config.js b/docusaurus.config.js index 8b7c8f671..0804186fc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -60,6 +60,14 @@ const config = { }, template: "src/template.mustache", // Customize API MDX with mustache template }, + stellar_disbursement_platform: { + specPath: "openapi/stellar-disbursement-platform/bundled.yml", // Path to designated spec file + outputDir: "api/stellar-disbursement-platform/resources", // Output directory for generated .mdx docs + sidebarOptions: { + groupPathsBy: "tag", + }, + template: "src/template.mustache", // Customize API MDX with mustache template + } }, }, ], @@ -143,6 +151,10 @@ const config = { to: "/api/anchor-platform", label: "Anchor Platform", }, + { + to: "/api/stellar-disbursement-platform", + label: "Stellar Disbursement Platform", + } ] }, { diff --git a/nginx/includes/redirects.conf b/nginx/includes/redirects.conf index b76dc09c2..16a5ed4d2 100644 --- a/nginx/includes/redirects.conf +++ b/nginx/includes/redirects.conf @@ -28,6 +28,6 @@ rewrite ^/docs/start/stellar-stack$ "/docs/fundamentals-and-concepts/stellar-sta rewrite ^/docs/tutorials/handling-errors$ "/docs/encyclopedia/error-handling" redirect; rewrite ^/docs/tutorials/securing-projects$ "/docs/encyclopedia/securing-web-based-projects" redirect; # moving /api/* locations to /api/horizon (leaving /api intact for the "overview page") -rewrite ^/api(/(?!horizon|anchor-platform).+)$ /api/horizon$1 redirect; +rewrite ^/api(/(?!horizon|(anchor|stellar-disbursement)-platform).+)$ /api/horizon$1 redirect; # moving /ap_api locations to /api/anchor-platform rewrite ^/ap_api(/.*)?$ /api/anchor-platform$1 redirect; diff --git a/openapi/stellar-disbursement-platform/bundled.yml b/openapi/stellar-disbursement-platform/bundled.yml new file mode 100644 index 000000000..14a16af83 --- /dev/null +++ b/openapi/stellar-disbursement-platform/bundled.yml @@ -0,0 +1,2699 @@ +swagger: '2.0' +info: + title: Stellar Disbursement Platform API + version: '' + description: The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform). +paths: + /login: + post: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + token: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + schema: + type: object + properties: + token: + type: string + example: + token: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Invalid credentials + extras: + status: 400 + message: Invalid username or password + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Invalid credentials + extras: + status: 400 + message: Invalid username or password + summary: Log In + operationId: Log In + description: 'Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.' + tags: + - Authentication + parameters: + - name: body + in: body + schema: + type: object + properties: + email: + type: string + password: + type: string + recaptcha_token: + type: string + description: Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true. + required: + - email + - password + example: + email: johndoe@mail.com + password: mysecret + produces: + - application/json + /refresh-token: + post: + responses: + '200': + description: Returns a new access token + headers: {} + examples: + application/json: + token: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + schema: + type: object + properties: + token: + type: string + example: + token: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + summary: Refresh Token + operationId: Refresh Token + description: A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires. + tags: + - Authentication + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + /mfa: + post: + summary: Provide Multi-Factor Authentication + description: Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required. + operationId: authenticateMFA + tags: + - Authentication + parameters: + - in: body + name: body + description: MFA request data + required: true + schema: + type: object + properties: + mfa_code: + type: string + description: Multi-factor authentication code + remember_me: + type: boolean + description: Boolean flag to remember the user + recaptcha_token: + type: string + description: Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true. + required: + - mfa_code + - in: header + name: Device-ID + type: string + required: false + description: Identifier of the device + responses: + '200': + description: Successful authentication + schema: + type: object + properties: + token: + type: string + description: Authentication token + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + produces: + - application/json + /forgot-password: + post: + summary: Forgot Password + description: Sends an email with a token to an SDP user who has gone through the Forgot Password process. + operationId: forgotPassword + tags: + - Authentication + parameters: + - in: body + name: body + description: Forgot password request data + required: true + schema: + type: object + properties: + email: + type: string + format: email + description: Email of the user + recaptcha_token: + type: string + description: Token for reCAPTCHA validation + required: + - email + responses: + '200': + description: Forgot password email sent successfully + schema: + $ref: '#/definitions/MessageResponse' + '400': + $ref: '#/responses/BadRequestResponse' + /reset-password: + post: + summary: Reset Rassword + description: Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email. + operationId: resetPassword + tags: + - Authentication + parameters: + - in: body + name: body + description: Reset password request data + required: true + schema: + type: object + properties: + password: + type: string + description: New password for the user + reset_token: + type: string + description: Token used to identify a valid password reset request + required: + - password + - reset_token + responses: + '200': + description: Password reset successfully + '400': + $ref: '#/responses/BadRequestResponse' + produces: + - application/json + /disbursements: + get: + responses: + '200': + description: A list of Disbursement details + schema: + $ref: '#/definitions/DisbursementPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: List All Disbursements + operationId: List All Disbursements + description: Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement. + tags: + - Disbursements + parameters: + - name: page + in: query + description: The page requested. + required: false + type: number + default: 1 + - name: page_limit + in: query + description: Define how many results will be returned in the response. + required: false + type: number + default: 20 + - name: q + in: query + description: A search term used to query through the disbursement names. + required: false + type: string + - name: status + in: query + description: Exact match on the status of the disbursement. + required: false + x-example: DRAFT + type: string + enum: + - DRAFT + - READY + - STARTED + - PAUSED + - COMPLETED + - name: created_at_after + in: query + description: 'Only return disbursements that are created after this date. Format: YYYY-MM-DD' + required: false + x-example: '2006-01-02' + type: string + - name: created_at_before + in: query + description: 'Only return disbursements that are created before this date. Format: YYYY-MM-DD' + required: false + x-example: '2006-01-02' + type: string + - name: sort + in: query + description: Field used to sort disbursements + required: false + type: string + default: created_at + enum: + - name + - created_at + - name: direction + in: query + description: Direction for sorting disbursements. + required: false + type: string + default: asc + enum: + - asc + - desc + produces: + - application/json + security: + - BearerAuth: [] + post: + responses: + '201': + description: A new disbursement + schema: + $ref: '#/definitions/Disbursement' + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Bad request + extras: + status: 400 + message: Invalid country code provided + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Bad request + extras: + status: 400 + message: Invalid country code provided + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Create Disbursement + operationId: Create Disbursement + description: 'Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.' + tags: + - Disbursements + parameters: + - name: body + in: body + schema: + type: object + properties: + name: + type: string + wallet_id: + type: string + asset_id: + type: string + country_code: + type: string + description: Two-character ISO 3166 code + example: + name: My New Disbursement name + wallet_id: e2de8544-b7e2-40a9-ad40-411f70d5c4bf + asset_id: d227a68c-2f40-11ee-be56-0242ac120002 + country_code: ua + produces: + - application/json + security: + - BearerAuth: [] + /disbursements/{id}: + get: + responses: + '200': + description: Disbursement details + schema: + $ref: '#/definitions/Disbursement' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Retrieve a Disbursement + operationId: Retrieve a Disbursement + description: Fetches information on a specific disbursement by ```id```. + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the `Disbursement`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /disbursements/{id}/receivers: + get: + responses: + '200': + description: A list of Disbursement Receivers + schema: + $ref: '#/definitions/DisbursementReceiverPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: List All Disbursement Receivers + operationId: List All Disbursement Receivers + description: Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination. + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the Disbursement + required: true + type: string + - name: page + in: query + description: The page number to fetch. + required: false + type: number + - name: page_limit + in: query + description: The number of records to return per page. + required: false + type: number + produces: + - application/json + security: + - BearerAuth: [] + /disbursements/{id}/instructions: + post: + responses: + '201': + description: Created + headers: {} + examples: + application/json: + message: File uploaded succesfully + schema: + type: object + properties: + message: + type: string + example: + message: File uploaded succesfully + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Invalid file format *.xyz + extras: + foo: bar + message: Not authorized + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + foo: + type: string + message: + type: string + example: + error: Invalid file format *.xyz + extras: + foo: bar + message: Not authorized + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Upload Disbursement Instructions + operationId: Upload Disbursement Instructions + description: Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called. + consumes: + - multipart/form-data + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the Disbursement + required: true + type: string + - name: file + in: formData + description: 'Disbursement instructions file to upload. The CSV file should be in the following format: `phone,id,amount,verification`' + required: true + type: file + produces: + - application/json + security: + - BearerAuth: [] + get: + responses: + '200': + description: Disbursement CSV file + headers: + Content-Disposition: + type: string + description: The filename of the returned CSV file. + Content-Type: + type: string + description: text/csv + examples: + text/csv: '' + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Invalid request + extras: + foo: bar + message: Invalid request parameters + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + foo: + type: string + message: + type: string + example: + error: Invalid request + extras: + foo: bar + message: Invalid request parameters + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Download Disbursement Instructions + operationId: Download Disbursement Instructions + description: Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement. + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the Disbursement + required: true + type: string + produces: + - text/csv + security: + - BearerAuth: [] + /disbursements/{id}/status: + patch: + responses: + '200': + description: Message Response + schema: + $ref: '#/definitions/MessageResponse' + examples: + application/json: + message: Disbursement started + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Bad request + extras: + status: 400 + message: Disbursement is not ready to be started + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Bad request + extras: + status: 400 + message: Disbursement is not ready to be started + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Update a Disbursement Status + operationId: Update a Disbursement Status + description: Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready. + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the disbursement + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /payments: + get: + responses: + '200': + description: A paginated list of payments + schema: + $ref: '#/definitions/PaymentPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: List All Payments + operationId: List All Payments + description: Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information. + tags: + - Payments + parameters: + - name: page + in: query + description: The page requested. + required: false + type: number + default: 1 + - name: page_limit + in: query + description: Define how many results will be returned in the response. + required: false + type: number + default: 20 + - name: status + in: query + description: Exact match on the status of the payment. + required: false + x-example: DRAFT + type: string + enum: + - DRAFT + - READY + - PENDING + - PAUSED + - SUCCESS + - FAILED + - name: receiver_id + in: query + description: UUID that represents a receiver in the database + required: false + x-example: b6b667ad-6cc2-46cf-9be7-561daace7d48 + type: string + - name: created_at_after + in: query + description: 'Only return payments that are created after this date. Format: YYYY-MM-DD' + required: false + x-example: '2006-01-02' + type: string + - name: created_at_before + in: query + description: 'Only return payments that are created before this date. Format: YYYY-MM-DD' + required: false + x-example: '2006-01-02' + type: string + - name: sort + in: query + description: Field used to sort payments + required: false + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting payments. + required: false + type: string + default: asc + enum: + - asc + - desc + produces: + - application/json + security: + - BearerAuth: [] + /payments/{id}: + get: + responses: + '200': + description: Payment details + schema: + $ref: '#/definitions/Payment' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Payment not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Payment not found + summary: Retrieve a Payment + operationId: Retrieve a Payment + description: Fetches detailed information on a specific payment by ```id```. + tags: + - Payments + parameters: + - name: id + in: path + description: ID of the `Payment`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /receivers: + get: + responses: + '200': + description: A paginated list of Receiver details + schema: + $ref: '#/definitions/ReceiverPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: List All Receivers + operationId: List All Receivers + description: Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver. + tags: + - Receivers + parameters: + - name: page + in: query + description: The page requested. + required: false + type: number + default: 1 + - name: page_limit + in: query + description: Define how many results will be returned in the response. + required: false + type: number + default: 20 + - name: q + in: query + description: A search term used to query through the receiver phone_number, email, and ID. + required: false + type: string + - name: status + in: query + description: Exact match on the status of the receiver wallet. + required: false + x-example: DRAFT + type: string + enum: + - DRAFT + - READY + - REGISTERED + - FLAGGED + - name: created_at_after + in: query + description: 'Only return receivers that are created after this date. Format: YYYY-MM-DD' + required: false + x-example: '2006-01-02' + type: string + - name: created_at_before + in: query + description: 'Only return receivers that are created before this date. Format: YYYY-MM-DD' + required: false + x-example: '2006-01-02' + type: string + - name: sort + in: query + description: Field used to sort receivers + required: false + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting receivers. + required: false + type: string + default: asc + enum: + - asc + - desc + produces: + - application/json + security: + - BearerAuth: [] + /receivers/{id}: + get: + responses: + '200': + description: Receiver Details + schema: + $ref: '#/definitions/Receiver' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + $ref: '#/responses/NotFoundResponse' + summary: Retrieve a Receiver + operationId: Retrieve a Receiver + description: Fetches detailed information on a specific receiver by ```id```, including all associated wallets. + tags: + - Receivers + parameters: + - name: id + in: path + description: ID of the `Receiver`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: Updated Receiver Details + schema: + $ref: '#/definitions/Receiver' + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + $ref: '#/responses/NotFoundResponse' + summary: Update a Receiver + operationId: Update a Receiver + description: This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver. + tags: + - Receivers + parameters: + - name: id + in: path + description: ID of the `Receiver`. + required: true + type: string + - name: body + in: body + description: List of fields to patch for the receiver + required: true + schema: + $ref: '#/definitions/PatchReceiverRequest' + produces: + - application/json + security: + - BearerAuth: [] + /statistics: + get: + responses: + '200': + description: General Statistics response + schema: + $ref: '#/definitions/GeneralStatistics' + '401': + $ref: '#/responses/UnauthorizedResponse' + summary: Retrieve All Statistics + operationId: Retrieve All Statistics + description: Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets. + tags: + - Statistics + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + /statistics/disbursements/{id}: + get: + responses: + '200': + description: Returns statistics for disbursement + schema: + $ref: '#/definitions/DisbursementsStatistics' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Retrieve Disbursement Statistics + operationId: Retrieve Disbursement Statistics + description: Fetches metrics on a specific disbursement by ```id```. + tags: + - Statistics + parameters: + - name: id + in: path + description: ID of the `Disbursement`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /wallet-registration/start: + get: + summary: Start Wallet Registration + operationId: Start Wallet Registration + description: This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request. + tags: + - Registration + produces: + - text/html + parameters: + - name: token + in: query + description: The SEP-24 token used for authentication + required: true + type: string + - name: transaction_id + in: query + description: The transaction id associated with the SEP-24 token + required: true + type: string + responses: + '200': + description: Token is valid and the webpage will be loaded normally. + schema: + type: string + description: HTML page content + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + /wallet-registration/otp: + post: + summary: Send One-Time Passcode + operationId: Send One-Time Passcode + description: This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request. + tags: + - Registration + consumes: + - application/json + produces: + - application/json + parameters: + - name: body + in: body + description: Object containing phone number + required: true + schema: + type: object + properties: + phone_number: + type: string + description: Phone number to which the OTP will be sent + recaptcha_token: + type: string + description: Token for reCAPTCHA validation + required: + - phone_number + - recaptcha_token + - name: Authorization + in: header + description: 'SEP-24 token for authorization (Format: ''Bearer {token}'')' + required: true + type: string + responses: + '200': + description: OTP sent successfully + schema: + $ref: '#/definitions/MessageResponse' + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '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. + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + code: + type: string + details: + type: string + /wallet-registration/verification: + post: + summary: Verify Receiver Registration + operationId: Verify Receiver Registration + 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 + consumes: + - application/json + produces: + - application/json + parameters: + - name: body + in: body + description: Verification data including phone number, OTP, verification value, and reCAPTCHA token + required: true + schema: + $ref: '#/definitions/ReceiverRegistrationRequest' + - name: Authorization + in: header + description: 'SEP-24 token for authorization (Format: ''Bearer {token}'')' + required: true + type: string + responses: + '200': + description: Verification successful + schema: + type: object + properties: + message: + type: string + example: ok + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + /.well-known/stellar.toml: + get: + responses: + '200': + description: Token is valid and the webpage will be loaded normally. + headers: {} + examples: + text/toml: | + ACCOUNTS=["GBC2HVWFIFN7WJHFORVBCDKJORXXXXXXXXXXXXXXXXXXXXXXXX", "GDA34JZ26FZY64XCSY46CUNSHLX762LHJXQXXXXXXXXXXXXXXXXXXXXXXXX"] SIGNING_KEY="GDA34JZ26FZY64XCSY46XXXXXXXXXXXXXXXXXXXXXXXX" NETWORK_PASSPHRASE="Test SDF Network ; September 2015" HORIZON_URL="https://horizon-testnet.stellar.org" WEB_AUTH_ENDPOINT="https://ap-stellar-disbursement-platform-backend-dev.stellar.org/auth" TRANSFER_SERVER_SEP0024="https://ap-stellar-disbursement-platform-backend-dev.stellar.org/sep24" + [[DOCUMENTATION]] ORG_NAME="Stellar Aid" + [[CURRENCIES]] code = "EUROC" issuer = "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5" is_asset_anchored = true anchor_asset_type = "fiat" status = "live" desc = "EUROC" + [[CURRENCIES]] code = "USDC" issuer = "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5" is_asset_anchored = true anchor_asset_type = "fiat" status = "live" desc = "USDC" + summary: Retrieve Stellar Info File + operationId: Retrieve Stellar Info File + description: Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url. + tags: + - Registration + parameters: [] + produces: + - text/toml + /WEB_AUTH_ENDPOINT: + get: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + transaction: AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag== + network_passphrase: Test SDF Network ; September 2015 + schema: + type: object + properties: + transaction: + type: string + network_passphrase: + type: string + example: + transaction: AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag== + network_passphrase: Test SDF Network ; September 2015 + '400': + description: If some information was missing or invalid. + headers: {} + examples: + application/json: + error: Bad request. + extras: + account: account cannot be empty + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + account: + type: string + example: + error: Bad request. + extras: + account: account cannot be empty + summary: Request Challenge Transaction + operationId: Request Challenge Transaction + description: Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable. + tags: + - Registration + parameters: + - name: account + in: query + description: The Client Account, which can be a stellar account (G...) or muxed account (M...) that the Client wishes to authenticate with the Server.. + required: true + type: string + - name: memo + in: query + description: The memo to attach to the challenge transaction. Only permitted if a Stellar account (G...) is used. The memo must be of type id. Other memo types are not supported. + required: false + type: string + - name: client_domain + in: query + description: a Client Domain. Need to be supplied by all Clients/Wallets. + required: true + type: string + produces: + - application/json + post: + responses: + '200': + description: SEP-10 handshake was successful. + headers: {} + examples: + application/json: + token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0 + schema: + type: object + properties: + token: + type: string + example: + token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0 + '401': + description: Unauthorized + headers: {} + examples: + application/json: + error: The provided transaction is not valid + schema: + type: object + properties: + error: + type: string + example: + error: The provided transaction is not valid + summary: Provide Signed Challenge Transaction + operationId: Provide Signed Challenge Transaction + description: Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable. + tags: + - Registration + parameters: + - name: body + in: body + schema: + type: object + properties: + transaction: + type: string + example: + transaction: AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ== + produces: + - application/json + /TRANSFER_SERVER_SEP0024/transactions/deposit/interactive: + post: + summary: Request Registration URL + description: | + The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. + It also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2). + externalDocs: + description: Find more info here + url: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2 + parameters: [] + tags: + - Registration + responses: + '200': + description: An anchor requires the user to fill out information on a webpage hosted by the anchor. + schema: + type: object + properties: + type: + type: string + description: Always set to interactive_customer_info_needed. + example: interactive_customer_info_needed + url: + type: string + description: URL hosted by the anchor. The wallet should show this URL to the user as a popup. + example: https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI + id: + type: string + description: The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request. + example: 82fhs729f63dh0v4 + /profile: + get: + responses: + '200': + description: Returns user profile + schema: + $ref: '#/definitions/Profile' + summary: Get Profile + operationId: Get Profile + description: Fetches the individual information of the logged in user to populate the Profile page. + tags: + - Profile + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + message: user profile updated successfully + schema: + $ref: '#/definitions/MessageResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update User Profile + operationId: Update User Profile + description: 'Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request.' + tags: + - Profile + parameters: + - name: body + in: body + schema: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + password: + type: string + example: + first_name: FirstName + last_name: LastName + email: email@email.com + password: mysecret + produces: + - application/json + security: + - BearerAuth: [] + /organization: + get: + responses: + '200': + description: Returns organization details + schema: + $ref: '#/definitions/Organization' + '401': + $ref: '#/responses/UnauthorizedResponse' + summary: Get Organization Info + operationId: Get Organization Info + description: This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account. + tags: + - Organization + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: OK + examples: + application/json: + message: organization profile updated successfully + schema: + $ref: '#/definitions/MessageResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update Organization Profile + operationId: Update Organization Profile + description: 'Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.' + tags: + - Organization + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - in: formData + name: logo + type: file + description: The logo of the organization, file type must be png or jpeg. + - in: formData + name: data + type: string + format: json + description: | + A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_workflow_enabled` (boolean): whether the approval workflow is enabled or not. For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_workflow_enabled": true}' + security: + - BearerAuth: [] + /organization/logo: + get: + summary: Retrieve Organization Logo + description: Retrieves the logo of the organization for display in the UI navbar. + operationId: GetOrganizationLogo + tags: + - Organization + produces: + - application/octet-stream + responses: + '200': + description: OK + schema: + type: string + format: binary + /countries: + get: + summary: Get All Countries + description: Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers. + tags: + - Organization + responses: + '200': + description: A list of countries + schema: + type: array + items: + $ref: '#/definitions/Country' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + produces: + - application/json + security: + - BearerAuth: [] + /assets: + get: + summary: Get All Assets + description: 'Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.' + tags: + - Organization + responses: + '200': + description: A list of assets + schema: + type: array + items: + $ref: '#/definitions/Asset' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + produces: + - application/json + security: + - BearerAuth: [] + post: + summary: Create Asset + description: 'This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.' + consumes: + - application/json + produces: + - application/json + tags: + - Organization + parameters: + - in: body + name: body + description: Asset to be created + required: true + schema: + type: object + properties: + code: + type: string + description: The asset code + example: USDC + issuer: + type: string + description: The issuer + example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5 + required: + - code + - issuer + responses: + '201': + description: Asset created successfully + '400': + description: Bad request, invalid request body or the provided code/issuer is invalid. + security: + - BearerAuth: [] + /assets/{id}: + delete: + summary: Delete Asset + description: This endpoint is used to soft delete an asset. + produces: + - application/json + tags: + - Organization + parameters: + - name: id + in: path + description: ID of the asset to delete + required: true + type: string + responses: + '200': + description: Asset deleted successfully + '204': + description: Asset already deleted + '404': + description: Asset not found + security: + - BearerAuth: [] + patch: + summary: Update Asset + description: This endpoint is used to update the metadata of an existing asset. + consumes: + - application/json + produces: + - application/json + tags: + - Organization + parameters: + - name: id + in: path + description: ID of the asset to update + required: true + type: string + - in: body + name: body + description: Asset metadata to be updated + required: true + schema: + type: object + properties: + code: + type: string + description: The asset code + issuer: + type: string + description: The issuer + required: + - code + - issuer + responses: + '200': + description: Asset updated successfully + '400': + description: Bad request, invalid request body or the provided code/issuer is invalid + '404': + description: Asset not found + security: + - BearerAuth: [] + /wallets: + get: + summary: Get All Wallets + description: Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets. + tags: + - Organization + responses: + '200': + description: A list of wallets + schema: + type: array + items: + $ref: '#/definitions/Wallet' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + produces: + - application/json + security: + - BearerAuth: [] + /users: + get: + responses: + '200': + description: Returns a paginated list of User Details + schema: + $ref: '#/definitions/Users' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Get All Users + operationId: Get All Users + description: Fetches all SDP users within the organization, whether they are active yet or not. + tags: + - Users + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + post: + responses: + '201': + description: Created + schema: + $ref: '#/definitions/User' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Create User + operationId: Create User + description: This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email. + tags: + - Users + parameters: + - name: body + in: body + schema: + type: object + properties: + first_name: + type: string + last_name: + type: string + roles: + type: array + items: + type: string + email: + type: string + example: + first_name: John + last_name: Doe + roles: + - business + email: email@email.com + produces: + - application/json + security: + - BearerAuth: [] + /users/activation: + patch: + responses: + '200': + description: Created + examples: + application/json: + message: user activation was updated successfully + schema: + $ref: '#/definitions/User' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update User Activation Status + operationId: Update User Activation Status + description: Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password. + tags: + - Users + parameters: + - name: body + in: body + schema: + type: object + properties: + user_id: + type: string + is_active: + type: boolean + example: + user_id: 5ca230c9-da95-4bd1-b2a2-aa5d0df65efd + is_active: false + produces: + - application/json + security: + - BearerAuth: [] + /users/roles: + get: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + roles: + - developer + - financial_controller + - business + - owner + schema: + type: object + properties: + roles: + type: array + items: + type: string + example: + roles: + - developer + - financial_controller + - business + - owner + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Get All Roles + operationId: Get All Roles + description: Fetches available SDP roles, such as owner, financial controller, business user, and developer. + tags: + - Users + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + message: user roles were updated successfully + schema: + type: object + properties: + message: + type: string + example: + message: user roles were updated successfully + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update User Role + operationId: Update User Role + description: Updates an SDP user’s role by ```user_ID```. + tags: + - Users + parameters: + - name: body + in: body + schema: + type: object + properties: + user_id: + type: string + roles: + type: array + items: + type: string + example: + user_id: 5ca230c9-da95-4bd1-b2a2-aa5d0df65efd + roles: + - developer + produces: + - application/json + security: + - BearerAuth: [] +definitions: + Amount: + type: object + properties: + asset_code: + type: string + example: USDC + asset_issuer: + type: string + example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5 + received_amount: + type: string + example: '100.00' + Asset: + type: object + properties: + id: + type: string + example: ffaec4b3-46b0-4db4-a4c4-6c3508057705 + code: + type: string + description: Asset code + example: USDC + issuer: + type: string + description: Asset issuer address + example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5 + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + deleted_at: + type: string + format: date-time + example: '2023-06-03T10:55:51.000Z' + Country: + type: object + properties: + code: + type: string + description: Country code in ISO 3166 alpha-3 + example: UKR + name: + type: string + description: Country name + example: Ukraine + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + Disbursement: + type: object + properties: + id: + type: string + description: The unique identifier of the disbursement + example: 619da857-8725-4c58-933d-c120a458e0f5 + name: + type: string + description: The name of the disbursement + example: Disbursement Name + country: + $ref: '#/definitions/Country' + wallet: + $ref: '#/definitions/Wallet' + asset: + $ref: '#/definitions/Asset' + status: + description: The status of the disbursement + $ref: '#/definitions/DisbursementStatus' + example: READY + verification_field: + $ref: '#/definitions/VerificationField' + example: DATE_OF_BIRTH + status_history: + $ref: '#/definitions/DisbursementStatusHistory' + file_name: + type: string + example: disbursement-feb-03-2023.csv + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + total_payments: + type: integer + description: Total number of payments + example: 10 + total_payments_sent: + type: integer + description: Total number of successful payments + example: 8 + total_payments_failed: + type: integer + description: Total number of failed payments + example: 1 + total_payments_remaining: + type: integer + description: Total number of remaining payments + example: 1 + amount_disbursed: + type: string + description: The total amount disbursed so far + example: '800.00' + total_amount: + type: string + description: The total amount to be disbursed + example: '1000.00' + average_amount: + type: string + description: The average amount per payment + example: '100.00' + DisbursementLite: + type: object + properties: + id: + type: string + format: uuid + description: The unique identifier of the disbursement + example: c51ba1d5-52d3-412f-a59c-6ef32d59ab43 + name: + type: string + description: The name of the disbursement + example: disbursement-june-29 + status: + $ref: '#/definitions/DisbursementStatus' + created_at: + type: string + format: date-time + description: The creation timestamp of the disbursement + example: '2023-06-30T01:22:57.831975Z' + updated_at: + type: string + format: date-time + description: The last update timestamp of the disbursement + example: '2023-06-30T01:22:58.316511Z' + DisbursementPagination: + type: object + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: array + items: + $ref: '#/definitions/Disbursement' + example: + pagination: + next: /disbursements?page=3&page_limit=1 + prev: /disbursements?page=1&page_limit=1 + pages: 4 + total: 4 + data: + id: 619da857-8725-4c58-933d-c120a458e0f5 + name: Disbursement Name + country: + code: UKR + name: Ukraine + created_at: '2023-02-03T10:45:51.000Z' + updated_at: '2023-02-03T10:45:51.000Z' + wallet: + id: e2de8544-b7e2-40a9-ad40-411f70d5c4bf + name: Vibrant + homepage: https://vibrantapp.com + asset: + id: 25923001-508a-4629-9186-c41211b2a3d0 + code: USDC + issuer: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5 + status: READY + verification_field: DATE_OF_BIRTH + status_history: + - user_id: null + status: DRAFT + timestamp: '2023-02-03T10:45:51.000Z' + - user_id: 2ec7f1f9-add3-4e6d-9d14-bd8ac5e88872 + status: READY + timestamp: '2023-02-03T10:45:51.000Z' + file_name: disbursement-february-03-2023.csv + created_at: '2023-02-03T10:45:51.000Z' + updated_at: '2023-02-03T10:45:51.000Z' + total_payments: 10 + total_payments_sent: 8 + total_payments_failed: 1 + total_payments_remaining: 1 + amount_disbursed: '800.00' + total_amount: '1000.00' + average_amount: '100.00' + DisbursementReceiver: + type: object + properties: + id: + type: string + example: ec3a57c0-5660-4b5a-af76-acadc7b09b93 + email: + type: string + example: receiver@mail.org + phone_number: + type: string + example: '+15552368475' + external_id: + type: string + example: usr129001 + receiver_wallet: + $ref: '#/definitions/ReceiverWallet' + payment: + $ref: '#/definitions/Payment' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + DisbursementReceiverPagination: + type: object + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: array + items: + $ref: '#/definitions/DisbursementReceiver' + DisbursementsStatistics: + type: object + properties: + payment_counters: + $ref: '#/definitions/PaymentCounters' + payment_amounts_by_asset: + type: array + items: + $ref: '#/definitions/PaymentAmountsByAsset' + receiver_wallets_counters: + $ref: '#/definitions/ReceiverWalletsCounters' + total_receivers: + type: integer + description: Total number of receivers + format: int64 + example: 100 + DisbursementStatus: + type: string + enum: + - DRAFT + - READY + - STARTED + - PAUSED + - COMPLETED + DisbursementStatusHistory: + type: array + items: + $ref: '#/definitions/DisbursementStatusHistoryEntry' + DisbursementStatusHistoryEntry: + type: object + properties: + user_id: + type: string + example: 3f351b9e-ed0f-40fa-a314-14757b42dab1 + status: + $ref: '#/definitions/DisbursementStatus' + timestamp: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + GeneralStatistics: + type: object + properties: + total_disbursements: + type: integer + description: Total number of disbursements + format: int64 + example: 20 + payment_counters: + $ref: '#/definitions/PaymentCounters' + payment_amounts_by_asset: + type: array + items: + $ref: '#/definitions/PaymentAmountsByAsset' + receiver_wallets_counters: + $ref: '#/definitions/ReceiverWalletsCounters' + total_receivers: + type: integer + description: Total number of receivers + format: int64 + example: 1000 + MessageResponse: + type: object + properties: + message: + type: string + required: + - message + Organization: + type: object + properties: + name: + type: string + example: Stellar Aid + logo_url: + type: string + example: https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo + distribution_account_public_key: + type: string + example: GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL + timezone_utc_offset: + type: string + example: '+00:00' + is_approval_workflow_enabled: + description: Enables multi-user approval workflow for disbursements + type: boolean + example: true + Pagination: + type: object + properties: + next: + type: string + example: '?page=3&page_limit=2' + prev: + type: string + example: '?page=1&page_limit=2' + pages: + type: integer + example: 8 + total: + type: integer + example: 16 + Payment: + type: object + properties: + id: + type: string + example: ddf22f55-3259-4822-a4e2-ce01334997f4 + amount: + type: string + example: '100.00' + stellar_transaction_id: + type: string + example: 0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b + stellar_operation_id: + type: string + status: + $ref: '#/definitions/PaymentStatus' + status_history: + $ref: '#/definitions/PaymentStatusHistory' + disbursement: + $ref: '#/definitions/DisbursementLite' + asset: + $ref: '#/definitions/Asset' + receiver_wallet: + $ref: '#/definitions/ReceiverWalletLite' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + PaymentPagination: + type: object + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: array + items: + $ref: '#/definitions/Payment' + PaymentStatus: + type: string + enum: + - DRAFT + - READY + - PENDING + - PAUSED + - SUCCESS + - FAILED + PaymentStatusHistory: + type: array + items: + $ref: '#/definitions/PaymentStatusHistoryEntry' + PaymentStatusHistoryEntry: + type: object + properties: + status: + $ref: '#/definitions/PaymentStatus' + status_message: + type: string + timestamp: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + PaymentCounters: + type: object + properties: + draft: + type: integer + format: int64 + example: 1 + ready: + type: integer + format: int64 + example: 2 + pending: + type: integer + format: int64 + example: 3 + paused: + type: integer + format: int64 + example: 1 + success: + type: integer + format: int64 + example: 5 + failed: + type: integer + format: int64 + example: 1 + total: + type: integer + format: int64 + example: 14 + PaymentAmountsByAsset: + type: object + properties: + asset_code: + type: string + example: USDC + payment_amounts: + $ref: '#/definitions/PaymentAmounts' + PaymentAmounts: + type: object + properties: + draft: + type: string + example: '100.00' + ready: + type: string + example: '200.00' + pending: + type: string + example: '300.00' + paused: + type: string + example: '100.00' + success: + type: string + example: '500.00' + failed: + type: string + example: '100.00' + average: + type: string + example: '100.00' + total: + type: string + example: '1400.00' + Profile: + type: object + properties: + first_name: + type: string + example: Jane + last_name: + type: string + example: Doe + email: + type: string + example: jdoe@mail.org + roles: + type: array + items: + type: string + organization_name: + type: string + example: + first_name: Jane + last_name: Doe + email: jdoe@mail.org + roles: + - developer + organization_name: Stellar Aid + Receiver: + type: object + properties: + id: + type: string + example: f83bb638-dda4-41e6-80c9-d03e6eec2aef + phone_number: + type: string + example: '+15552368475' + external_id: + type: string + example: usr12334 + email: + type: string + example: jdoe@mail.org + created_at: + type: string + example: '2023-02-03T10:45:51.000Z' + total_payments: + type: string + example: '2' + successful_payments: + type: string + example: '2' + failed_payments: + type: string + example: '0' + remaining_payments: + type: string + example: '0' + registered_wallets: + type: string + example: 1 + received_amounts: + type: array + items: + $ref: '#/definitions/Amount' + wallets: + type: array + items: + $ref: '#/definitions/ReceiverWallet' + ReceiverLite: + type: object + properties: + id: + type: string + example: 029e2ed0-feb6-4c40-8b47-0836a85741a2 + ReceiverPagination: + type: object + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: array + items: + $ref: '#/definitions/Receiver' + ReceiverWallet: + type: object + properties: + id: + type: string + example: 803031d4-1d04-4879-b6d9-dc5641f9988e + receiver: + $ref: '#/definitions/ReceiverLite' + wallet: + $ref: '#/definitions/WalletLite' + stellar_address: + type: string + example: GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL + stellar_memo: + type: string + stellar_memo_type: + type: string + created_at: + type: string + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + example: '2023-02-03T10:45:51.000Z' + invited_at: + type: string + example: '2023-02-09T10:45:51.000Z' + last_sms_sent: + type: string + example: '2023-02-10T10:45:51.000Z' + description: timestamp when the receiver last received an SMS about this wallet + total_payments: + type: string + example: '2' + payments_received: + type: string + example: '2' + failed_payments: + type: string + example: '0' + remaining_payments: + type: string + example: '0' + received_amounts: + type: array + items: + $ref: '#/definitions/Amount' + status: + $ref: '#/definitions/ReceiversWalletStatus' + status_history: + type: array + items: + $ref: '#/definitions/ReceiversWalletStatusHistoryEntry' + ReceiverWalletLite: + type: object + properties: + id: + type: string + example: 803031d4-1d04-4879-b6d9-dc5641f9988e + receiver: + $ref: '#/definitions/ReceiverLite' + wallet: + $ref: '#/definitions/WalletLite' + stellar_address: + type: string + example: GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL + created_at: + type: string + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + example: '2023-02-03T10:45:51.000Z' + status: + $ref: '#/definitions/ReceiversWalletStatus' + ReceiverWalletsCounters: + type: object + properties: + draft: + type: integer + format: int64 + example: 1 + ready: + type: integer + format: int64 + example: 1 + registered: + type: integer + format: int64 + example: 1 + flagged: + type: integer + format: int64 + example: 1 + total: + type: integer + format: int64 + example: 4 + ReceiversWalletStatus: + type: string + enum: + - DRAFT + - READY + - REGISTERED + - FLAGGED + ReceiversWalletStatusHistoryEntry: + type: object + properties: + status: + $ref: '#/definitions/ReceiversWalletStatus' + timestamp: + type: string + format: date-time + example: '2023-02-10T10:45:51.000Z' + Users: + type: array + items: + $ref: '#/definitions/User' + User: + type: object + properties: + id: + type: string + example: 1736bed3-7b92-4760-8ff2-51fb08ee079f + first_name: + type: string + example: John + last_name: + type: string + example: Doe + email: + type: string + roles: + type: array + items: + type: string + is_active: + type: boolean + required: + - id + - first_name + - last_name + - email + - roles + - is_active + example: + - id: 7a4c6555-1f73-49b3-a211-f95bd2b8ec90 + first_name: John + last_name: Doe + email: email@email.com + roles: + - developer + is_active: true + - id: 5f4df1dd-c84f-482a-84ad-541ffd46e75a + first_name: Jane + last_name: Doe + email: email@email.com + roles: + - financial_controller + is_active: false + VerificationField: + type: string + enum: + - DATE_OF_BIRTH + - PIN + - NATIONAL_ID_NUMBER + Wallet: + type: object + properties: + id: + type: string + example: 5ada9ed5-455a-4782-a0ee-160767e0deb1 + name: + type: string + example: Vibrant Assist + homepage: + type: string + example: https://vibrantapp.com + sep_10_client_domain: + type: string + example: api-dev.vibrantapp.com + deep_link_schema: + type: string + example: https://vibrantapp.com/sdp-dev + created_at: + type: string + format: date-time + example: '2023-07-31T20:50:45.648Z' + updated_at: + type: string + format: date-time + example: '2023-07-31T20:50:45.648Z' + WalletLite: + type: object + properties: + id: + type: string + example: 5ada9ed5-455a-4782-a0ee-160767e0deb1 + name: + type: string + example: Vibrant Assist + homepage: + type: string + example: https://vibrantapp.com + ReceiverRegistrationRequest: + 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 + PatchReceiverRequest: + type: object + properties: + date_of_birth: + type: string + description: Date of birth of the receiver + pin: + type: string + description: Personal identification number of the receiver + national_id: + type: string + description: National ID of the receiver + email: + type: string + description: Email of the receiver + external_id: + type: string + description: External ID of the receiver + example: + date_of_birth: '1980-01-01' + pin: '1234' + national_id: '123456789' + email: john@example.com + external_id: external123 +responses: + UnauthorizedResponse: + description: Unauthorized + headers: {} + examples: + application/json: + error: Not authorized + extras: + status: 401 + message: Not authorized + 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 + ForbiddenResponse: + description: Forbidden + headers: {} + examples: + application/json: + error: Forbidden + schema: + type: object + properties: + error: + type: string + example: + error: Forbidden + BadRequestResponse: + description: Bad Request + schema: + type: object + properties: + message: + type: string + description: Details about the error + NotFoundResponse: + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Resource not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string +securityDefinitions: + BearerAuth: + type: apiKey + name: Authorization + in: header + description: JWT used for authentication, signed with an ES256 private key. +tags: + - name: Authentication + description: Authentication endpoints control the login, token refresh, and password management processes for SDP users. + - name: Disbursements + description: Endpoints related to disbursements. A disbursement is a group of payments sent to multiple individuals at once. An SDP user with the appropriate role triggers a new disbursement through the SDP dashboard by uploading a list of receivers and amounts. When the receiver has linked their wallet to the SDP, the payment automatically begins. SDP users can track their disbursements in real-time through the SDP dashboard. Each disbursement must have a unique name defined by the organization. + - name: Payments + description: Endpoints related to payments. An SDP payment is an individual payment from an organization to a receiver. Each payment is part of a disbursement and occurs on the Stellar network. Granular payment status is stored in the SDP database and can be viewed in real-time on the SDP dashboard. There is no POST endpoint because submitting payments to the Stellar network is handled by the Transaction Submission Service (TSS). + - name: Receivers + description: |- + Endpoints related to receivers. A receiver is an individual receiving a payment in a disbursement. The receiver is tracked by phone number to reduce the need for personally identifiable information. Each receiver must be unique within the disbursement. + + Each receiver will have at least one wallet associated with them. The wallet public key will remain null until the receiver registers with a wallet provider and links the wallet to the SDP through SEP-24. Receivers must verify their identity through that process, which requires the SDP to store verification information on receivers like date of birth, national ID number, or personal PIN. This information can be updated by the organization through the receiver endpoints. + - name: Statistics + description: Statistics endpoints return general aggregated data per organization, as well as disbursement-specific metrics. SDP users can use this data to monitor their disbursements over time. + - name: Registration + description: |- + The registration endpoints guide the process for a receiver to verify their identity and link their wallet address to an SDP. + + The registration process only needs to happen once per receiver to link their wallet. Only SDP-compatible wallet providers can facilitate the registration process. These endpoints must be supported and hit by the wallet providers after the receiver gets the initial SMS invite. After the wallet address is successfully linked, the payment automatically begins. + + The SDP<>wallet registration process uses SEP-10, SEP-24, and deep links. Please see the SDP [developer docs](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform) for a full set of instructions for wallet providers to become SDP-compatible. + - name: Profile + description: 'Profiles endpoints manage the process of getting and updating individual profile information. Profile information is set when the account is created and can be updated by the user on the SDP dashboard Profile page. Note: profiles never refer to receivers of funds.' + - name: Organization + description: Organization endpoints manage the process of getting and updating organizational profile information. The organization’s profile has basic information set at the time of SDP deployment. It can be modified by the Owner. Organizations can also manage their preferences, like which assets to use, through these endpoints. + - name: Users + description: The users endpoints facilitate the creation of new SDP users–including setting the appropriate role, sending an email invitation, and activating a user–and managing roles. diff --git a/openapi/stellar-disbursement-platform/main.yml b/openapi/stellar-disbursement-platform/main.yml new file mode 100644 index 000000000..30a27742a --- /dev/null +++ b/openapi/stellar-disbursement-platform/main.yml @@ -0,0 +1,2806 @@ +swagger: '2.0' +info: + title: Stellar Disbursement Platform API + version: '' + description: The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform). +paths: + /login: + post: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + token: >- + eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + schema: + type: object + properties: + token: + type: string + example: + token: >- + eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Invalid credentials + extras: + status: 400 + message: Invalid username or password + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Invalid credentials + extras: + status: 400 + message: Invalid username or password + summary: Log In + operationId: Log In + description: 'Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.' + tags: + - Authentication + parameters: + - name: body + in: body + schema: + type: object + properties: + email: + type: string + password: + type: string + recaptcha_token: + type: string + description: "Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true." + required: + - email + - password + example: + email: johndoe@mail.com + password: mysecret + produces: + - application/json + /refresh-token: + post: + responses: + '200': + description: Returns a new access token + headers: {} + examples: + application/json: + token: >- + eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + schema: + type: object + properties: + token: + type: string + example: + token: >- + eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + summary: Refresh Token + operationId: Refresh Token + description: 'A user’s token expires after 15 minutes. This endpoint handles refreshing the user’s token without disrupting their experience. It is triggered within the 30-second window before the token expires.' + tags: + - Authentication + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + /mfa: + post: + summary: Provide Multi-Factor Authentication + description: 'Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.' + operationId: authenticateMFA + tags: + - Authentication + parameters: + - in: body + name: body + description: MFA request data + required: true + schema: + type: object + properties: + mfa_code: + type: string + description: Multi-factor authentication code + remember_me: + type: boolean + description: Boolean flag to remember the user + recaptcha_token: + type: string + description: "Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true." + required: + - mfa_code + - in: header + name: Device-ID + type: string + required: false + description: Identifier of the device + responses: + '200': + description: Successful authentication + schema: + type: object + properties: + token: + type: string + description: Authentication token + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + produces: + - application/json + /forgot-password: + post: + summary: Forgot Password + description: 'Sends an email with a token to an SDP user who has gone through the Forgot Password process.' + operationId: forgotPassword + tags: + - Authentication + parameters: + - in: body + name: body + description: Forgot password request data + required: true + schema: + type: object + properties: + email: + type: string + format: email + description: Email of the user + recaptcha_token: + type: string + description: Token for reCAPTCHA validation + required: + - email + responses: + '200': + description: Forgot password email sent successfully + schema: + $ref: '#/definitions/MessageResponse' + '400': + $ref: '#/responses/BadRequestResponse' + /reset-password: + post: + summary: Reset Rassword + description: 'Allows an SDP user who has gone through the Forgot Password process to set their new password with a token sent via email.' + operationId: resetPassword + tags: + - Authentication + parameters: + - in: body + name: body + description: Reset password request data + required: true + schema: + type: object + properties: + password: + type: string + description: New password for the user + reset_token: + type: string + description: Token used to identify a valid password reset request + required: + - password + - reset_token + responses: + '200': + description: Password reset successfully + '400': + $ref: '#/responses/BadRequestResponse' + produces: + - application/json + /disbursements: + get: + responses: + '200': + description: "A list of Disbursement details" + schema: + $ref: '#/definitions/DisbursementPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: List All Disbursements + operationId: List All Disbursements + description: 'Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.' + tags: + - Disbursements + parameters: + - name: page + in: query + description: The page requested. + required: false + type: number + default: 1 + - name: page_limit + in: query + description: Define how many results will be returned in the response. + required: false + type: number + default: 20 + - name: q + in: query + description: A search term used to query through the disbursement names. + required: false + type: string + - name: status + in: query + description: Exact match on the status of the disbursement. + required: false + x-example: DRAFT + type: string + enum: + - DRAFT + - READY + - STARTED + - PAUSED + - COMPLETED + - name: created_at_after + in: query + description: >- + Only return disbursements that are created after this date. Format: + YYYY-MM-DD + required: false + x-example: '2006-01-02' + type: string + - name: created_at_before + in: query + description: >- + Only return disbursements that are created before this date. Format: + YYYY-MM-DD + required: false + x-example: '2006-01-02' + type: string + - name: sort + in: query + description: Field used to sort disbursements + required: false + type: string + default: created_at + enum: + - name + - created_at + - name: direction + in: query + description: Direction for sorting disbursements. + required: false + type: string + default: asc + enum: + - asc + - desc + produces: + - application/json + security: + - BearerAuth: [] + post: + responses: + '201': + description: "A new disbursement" + schema: + $ref: '#/definitions/Disbursement' + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Bad request + extras: + status: 400 + message: Invalid country code provided + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Bad request + extras: + status: 400 + message: Invalid country code provided + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Create Disbursement + operationId: Create Disbursement + description: 'Creates a new disbursement in ```draft``` state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from ```draft``` to ```ready```.' + tags: + - Disbursements + parameters: + - name: body + in: body + schema: + type: object + properties: + name: + type: string + wallet_id: + type: string + asset_id: + type: string + country_code: + type: string + description: 'Two-character ISO 3166 code' + example: + name: My New Disbursement name + wallet_id: e2de8544-b7e2-40a9-ad40-411f70d5c4bf + asset_id: d227a68c-2f40-11ee-be56-0242ac120002 + country_code: ua + produces: + - application/json + security: + - BearerAuth: [] + /disbursements/{id}: + get: + responses: + '200': + description: "Disbursement details" + schema: + $ref: '#/definitions/Disbursement' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Retrieve a Disbursement + operationId: Retrieve a Disbursement + description: 'Fetches information on a specific disbursement by ```id```.' + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the `Disbursement`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /disbursements/{id}/receivers: + get: + responses: + '200': + description: "A list of Disbursement Receivers" + schema: + $ref: '#/definitions/DisbursementReceiverPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: List All Disbursement Receivers + operationId: List All Disbursement Receivers + description: 'Fetches a list of receivers within a specific disbursement using the disbursement ```id```. This endpoint supports pagination.' + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the Disbursement + required: true + type: string + - name: page + in: query + description: The page number to fetch. + required: false + type: number + - name: page_limit + in: query + description: The number of records to return per page. + required: false + type: number + produces: + - application/json + security: + - BearerAuth: [] + /disbursements/{id}/instructions: + post: + responses: + '201': + description: Created + headers: {} + examples: + application/json: + message: File uploaded succesfully + schema: + type: object + properties: + message: + type: string + example: + message: File uploaded succesfully + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Invalid file format *.xyz + extras: + foo: bar + message: Not authorized + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + foo: + type: string + message: + type: string + example: + error: Invalid file format *.xyz + extras: + foo: bar + message: Not authorized + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Upload Disbursement Instructions + operationId: Upload Disbursement Instructions + description: 'Adds a file containing a list of receivers to a ```draft``` disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a standard format that can be found at ```dev/sample/sample-disbursement.csv```. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.' + consumes: + - multipart/form-data + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the Disbursement + required: true + type: string + - name: "file" + in: "formData" + description: "Disbursement instructions file to upload. The CSV file should be in the following format: `phone,id,amount,verification`" + required: true + type: "file" + produces: + - application/json + security: + - BearerAuth: [] + get: + responses: + '200': + description: "Disbursement CSV file" + headers: + Content-Disposition: + type: string + description: "The filename of the returned CSV file." + Content-Type: + type: string + description: "text/csv" + examples: + text/csv: '' + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Invalid request + extras: + foo: bar + message: Invalid request parameters + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + foo: + type: string + message: + type: string + example: + error: Invalid request + extras: + foo: bar + message: Invalid request parameters + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Download Disbursement Instructions + operationId: Download Disbursement Instructions + description: 'Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.' + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the Disbursement + required: true + type: string + produces: + - text/csv + security: + - BearerAuth: [] + /disbursements/{id}/status: + patch: + responses: + '200': + description: "Message Response" + schema: + $ref: '#/definitions/MessageResponse' + examples: + application/json: + message: Disbursement started + '400': + description: Bad Request + headers: {} + examples: + application/json: + error: Bad request + extras: + status: 400 + message: Disbursement is not ready to be started + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Bad request + extras: + status: 400 + message: Disbursement is not ready to be started + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Disbursement not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Disbursement not found + summary: Update a Disbursement Status + operationId: Update a Disbursement Status + description: 'Updates the status of a disbursement according to the state machine. The disbursement must move from ```draft``` to ```ready``` in order to start the disbursement and trigger payments. Payments will start as soon as this endpoint is hit. A disbursement can also be moved into ```paused``` state by an SDP user to prevent further payments from going out and restarted when they are ready.' + tags: + - Disbursements + parameters: + - name: id + in: path + description: ID of the disbursement + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /payments: + get: + responses: + '200': + description: "A paginated list of payments" + schema: + $ref: '#/definitions/PaymentPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: List All Payments + operationId: List All Payments + description: 'Returns all individual payments matching the request criteria. This endpoint supports pagination and filtering on payment status, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.' + tags: + - Payments + parameters: + - name: page + in: query + description: The page requested. + required: false + type: number + default: 1 + - name: page_limit + in: query + description: Define how many results will be returned in the response. + required: false + type: number + default: 20 + - name: status + in: query + description: Exact match on the status of the payment. + required: false + x-example: DRAFT + type: string + enum: + - DRAFT + - READY + - PENDING + - PAUSED + - SUCCESS + - FAILED + - name: receiver_id + in: query + description: UUID that represents a receiver in the database + required: false + x-example: b6b667ad-6cc2-46cf-9be7-561daace7d48 + type: string + - name: created_at_after + in: query + description: >- + Only return payments that are created after this date. Format: + YYYY-MM-DD + required: false + x-example: '2006-01-02' + type: string + - name: created_at_before + in: query + description: >- + Only return payments that are created before this date. Format: + YYYY-MM-DD + required: false + x-example: '2006-01-02' + type: string + - name: sort + in: query + description: Field used to sort payments + required: false + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting payments. + required: false + type: string + default: asc + enum: + - asc + - desc + produces: + - application/json + security: + - BearerAuth: [] + /payments/{id}: + get: + responses: + '200': + description: "Payment details" + schema: + $ref: '#/definitions/Payment' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Payment not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string + example: + error: Not found + extras: + status: 404 + message: Payment not found + summary: Retrieve a Payment + operationId: Retrieve a Payment + description: 'Fetches detailed information on a specific payment by ```id```.' + tags: + - Payments + parameters: + - name: id + in: path + description: ID of the `Payment`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /receivers: + get: + responses: + '200': + description: "A paginated list of Receiver details" + schema: + $ref: '#/definitions/ReceiverPagination' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: List All Receivers + operationId: List All Receivers + description: 'Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.' + tags: + - Receivers + parameters: + - name: page + in: query + description: The page requested. + required: false + type: number + default: 1 + - name: page_limit + in: query + description: Define how many results will be returned in the response. + required: false + type: number + default: 20 + - name: q + in: query + description: >- + A search term used to query through the receiver phone_number, + email, and ID. + required: false + type: string + - name: status + in: query + description: Exact match on the status of the receiver wallet. + required: false + x-example: DRAFT + type: string + enum: + - DRAFT + - READY + - REGISTERED + - FLAGGED + - name: created_at_after + in: query + description: >- + Only return receivers that are created after this date. Format: + YYYY-MM-DD + required: false + x-example: '2006-01-02' + type: string + - name: created_at_before + in: query + description: >- + Only return receivers that are created before this date. Format: + YYYY-MM-DD + required: false + x-example: '2006-01-02' + type: string + - name: sort + in: query + description: Field used to sort receivers + required: false + type: string + default: created_at + enum: + - created_at + - name: direction + in: query + description: Direction for sorting receivers. + required: false + type: string + default: asc + enum: + - asc + - desc + produces: + - application/json + security: + - BearerAuth: [] + /receivers/{id}: + get: + responses: + '200': + description: "Receiver Details" + schema: + $ref: '#/definitions/Receiver' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + $ref: '#/responses/NotFoundResponse' + + summary: Retrieve a Receiver + operationId: Retrieve a Receiver + description: 'Fetches detailed information on a specific receiver by ```id```, including all associated wallets.' + tags: + - Receivers + parameters: + - name: id + in: path + description: ID of the `Receiver`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: "Updated Receiver Details" + schema: + $ref: '#/definitions/Receiver' + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + '404': + $ref: '#/responses/NotFoundResponse' + summary: Update a Receiver + operationId: Update a Receiver + description: 'This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.' + tags: + - Receivers + parameters: + - name: id + in: path + description: ID of the `Receiver`. + required: true + type: string + - name: body + in: body + description: List of fields to patch for the receiver + required: true + schema: + $ref: '#/definitions/PatchReceiverRequest' + produces: + - application/json + security: + - BearerAuth: [] + /statistics: + get: + responses: + '200': + description: 'General Statistics response' + schema: + $ref: '#/definitions/GeneralStatistics' + '401': + $ref: '#/responses/UnauthorizedResponse' + summary: Retrieve All Statistics + operationId: Retrieve All Statistics + description: 'Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.' + tags: + - Statistics + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + /statistics/disbursements/{id}: + get: + responses: + '200': + description: 'Returns statistics for disbursement' + schema: + $ref: '#/definitions/DisbursementsStatistics' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Retrieve Disbursement Statistics + operationId: Retrieve Disbursement Statistics + description: 'Fetches metrics on a specific disbursement by ```id```.' + tags: + - Statistics + parameters: + - name: id + in: path + description: ID of the `Disbursement`. + required: true + type: string + produces: + - application/json + security: + - BearerAuth: [] + /wallet-registration/start: + get: + summary: Start Wallet Registration + operationId: Start Wallet Registration + description: >- + This is the endpoint the browser reaches with the first token so that the receiver can confirm their verification information through a webflow. Requires a valid SEP-24 token in the request. + tags: + - Registration + produces: + - text/html + parameters: + - name: token + in: query + description: The SEP-24 token used for authentication + required: true + type: string + - name: transaction_id + in: query + description: The transaction id associated with the SEP-24 token + required: true + type: string + responses: + '200': + description: Token is valid and the webpage will be loaded normally. + schema: + type: string + description: HTML page content + '401': + $ref: '#/responses/UnauthorizedResponse' + '400': + $ref: '#/responses/BadRequestResponse' + /wallet-registration/otp: + post: + summary: Send One-Time Passcode + operationId: Send One-Time Passcode + description: >- + This endpoint generates a 6-digit OTP and sends it via SMS to the phone number provided in the request body (after checking that the phone number matches a receiver phone number in the SDP). A valid SEP-24 token should be included in the Authorization header of the request. + tags: + - Registration + consumes: + - application/json + produces: + - application/json + parameters: + - name: body + in: body + description: Object containing phone number + required: true + schema: + type: object + properties: + phone_number: + type: string + description: Phone number to which the OTP will be sent + recaptcha_token: + type: string + description: "Token for reCAPTCHA validation" + required: + - phone_number + - recaptcha_token + - name: Authorization + in: header + description: "SEP-24 token for authorization (Format: 'Bearer {token}')" + required: true + type: string + responses: + '200': + description: OTP sent successfully + schema: + $ref: '#/definitions/MessageResponse' + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '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. + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + code: + type: string + details: + type: string + /wallet-registration/verification: + post: + summary: Verify Receiver Registration + operationId: Verify Receiver Registration + 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 + consumes: + - application/json + produces: + - application/json + parameters: + - name: body + in: body + description: Verification data including phone number, OTP, verification value, and reCAPTCHA token + required: true + schema: + $ref: '#/definitions/ReceiverRegistrationRequest' + - name: Authorization + in: header + description: "SEP-24 token for authorization (Format: 'Bearer {token}')" + required: true + type: string + responses: + '200': + description: Verification successful + schema: + type: object + properties: + message: + type: string + example: "ok" + '400': + $ref: '#/responses/BadRequestResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + /.well-known/stellar.toml: + get: + responses: + '200': + description: Token is valid and the webpage will be loaded normally. + headers: {} + examples: + text/toml: > + ACCOUNTS=["GBC2HVWFIFN7WJHFORVBCDKJORXXXXXXXXXXXXXXXXXXXXXXXX", "GDA34JZ26FZY64XCSY46CUNSHLX762LHJXQXXXXXXXXXXXXXXXXXXXXXXXX"] + SIGNING_KEY="GDA34JZ26FZY64XCSY46XXXXXXXXXXXXXXXXXXXXXXXX" + NETWORK_PASSPHRASE="Test SDF Network ; September 2015" + HORIZON_URL="https://horizon-testnet.stellar.org" + WEB_AUTH_ENDPOINT="https://ap-stellar-disbursement-platform-backend-dev.stellar.org/auth" + TRANSFER_SERVER_SEP0024="https://ap-stellar-disbursement-platform-backend-dev.stellar.org/sep24" + + [[DOCUMENTATION]] + ORG_NAME="Stellar Aid" + + [[CURRENCIES]] + code = "EUROC" + issuer = "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5" + is_asset_anchored = true + anchor_asset_type = "fiat" + status = "live" + desc = "EUROC" + + [[CURRENCIES]] + code = "USDC" + issuer = "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5" + is_asset_anchored = true + anchor_asset_type = "fiat" + status = "live" + desc = "USDC" + summary: Retrieve Stellar Info File + operationId: Retrieve Stellar Info File + description: >- + Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url. + tags: + - Registration + parameters: [] + produces: + - text/toml + /WEB_AUTH_ENDPOINT: + get: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + transaction: >- + AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag== + network_passphrase: Test SDF Network ; September 2015 + schema: + type: object + properties: + transaction: + type: string + network_passphrase: + type: string + example: + transaction: >- + AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAfheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3Ag== + network_passphrase: Test SDF Network ; September 2015 + '400': + description: If some information was missing or invalid. + headers: {} + examples: + application/json: + error: Bad request. + extras: + account: account cannot be empty + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + account: + type: string + example: + error: Bad request. + extras: + account: account cannot be empty + summary: Request Challenge Transaction + operationId: Request Challenge Transaction + description: >- + Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the ```WEB_AUTH_ENDPOINT``` variable. + tags: + - Registration + parameters: + - name: account + in: query + description: >- + The Client Account, which can be a stellar account (G...) or muxed + account (M...) that the Client wishes to authenticate with the + Server.. + required: true + type: string + - name: memo + in: query + description: >- + The memo to attach to the challenge transaction. Only permitted if a + Stellar account (G...) is used. The memo must be of type id. Other + memo types are not supported. + required: false + type: string + - name: client_domain + in: query + description: a Client Domain. Need to be supplied by all Clients/Wallets. + required: true + type: string + produces: + - application/json + post: + responses: + '200': + description: SEP-10 handshake was successful. + headers: {} + examples: + application/json: + token: >- + eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0 + schema: + type: object + properties: + token: + type: string + example: + token: >- + eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHQTZVSVhYUEVXWUZJTE5VSVdBQzM3WTRRUEVaTVFWREpIREtWV0ZaSjJLQ1dVQklVNUlYWk5EQSIsImp0aSI6IjE0NGQzNjdiY2IwZTcyY2FiZmRiZGU2MGVhZTBhZDczM2NjNjVkMmE2NTg3MDgzZGFiM2Q2MTZmODg1MTkwMjQiLCJpc3MiOiJodHRwczovL2ZsYXBweS1iaXJkLWRhcHAuZmlyZWJhc2VhcHAuY29tLyIsImlhdCI6MTUzNDI1Nzk5NCwiZXhwIjoxNTM0MzQ0Mzk0fQ.8nbB83Z6vGBgC1X9r3N6oQCFTBzDiITAfCJasRft0z0 + '401': + description: Unauthorized + headers: {} + examples: + application/json: + error: The provided transaction is not valid + schema: + type: object + properties: + error: + type: string + example: + error: The provided transaction is not valid + summary: Provide Signed Challenge Transaction + operationId: Provide Signed Challenge Transaction + description: >- + Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the ```WEB_AUTH_ENDPOINT``` variable. + tags: + - Registration + parameters: + - name: body + in: body + schema: + type: object + properties: + transaction: + type: string + example: + transaction: >- + AAAAAgAAAADIiRu2BrqqeOcP28PWCkD4D5Rjjsqh71HwvqFX+F4VXAAAAGQAAAAAAAAAAAAAAAEAAAAAXzrUcQAAAABfOtf1AAAAAAAAAAEAAAABAAAAAEEB8rhqNa70RYjaNnF1ARE2CbL50iR9HPXST/fImJN1AAAACgAAADB0aGlzaXNhdGVzdC5zYW5kYm94LmFuY2hvci5hbmNob3Jkb21haW4uY29tIGF1dGgAAAABAAAAQGdGOFlIQm1zaGpEWEY0L0VJUFZucGVlRkxVTDY2V0tKMVBPYXZuUVVBNjBoL09XaC91M2Vvdk54WFJtSTAvQ2UAAAAAAAAAAvheFVwAAABAheKE1HjGnUCNwPbX8mz7CqotShKbA+xM2Hbjl6X0TBpEprVOUVjA6lqMJ1j62vrxn1mF3eJzsLa9s9hRofG3AsiYk3UAAABArIrkvqmA0V9lIZcVyCUdja6CiwkPwsV8BfI4CZOyR1Oq7ysvNJWwY0G42dpxN9OP1qz4dum8apG2hqvxVWjkDQ== + produces: + - application/json + /TRANSFER_SERVER_SEP0024/transactions/deposit/interactive: + post: + summary: Request Registration URL + description: > + The deposit endpoint allows a wallet to get deposit information from an anchor, + so a user has all the information needed to initiate a deposit. + + It also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. + Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2). + externalDocs: + description: Find more info here + url: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2 + parameters: [] + tags: + - Registration + responses: + '200': + description: An anchor requires the user to fill out information on a webpage hosted by the anchor. + schema: + type: object + properties: + type: + type: string + description: Always set to interactive_customer_info_needed. + example: "interactive_customer_info_needed" + url: + type: string + description: URL hosted by the anchor. The wallet should show this URL to the user as a popup. + example: "https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI" + id: + type: string + description: The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request. + example: "82fhs729f63dh0v4" + + /profile: + get: + responses: + '200': + description: 'Returns user profile' + schema: + $ref: '#/definitions/Profile' + + summary: Get Profile + operationId: Get Profile + description: 'Fetches the individual information of the logged in user to populate the Profile page.' + tags: + - Profile + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + message: user profile updated successfully + schema: + $ref: '#/definitions/MessageResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update User Profile + operationId: Update User Profile + description: >- + Updates the profile details of the logged in user, including changing password for authenticated/logged in users. Note: all fields are optional but at least one should be sent in the request. + tags: + - Profile + parameters: + - name: body + in: body + schema: + type: object + properties: + first_name: + type: string + last_name: + type: string + email: + type: string + password: + type: string + example: + first_name: FirstName + last_name: LastName + email: email@email.com + password: mysecret + produces: + - application/json + security: + - BearerAuth: [] + /organization: + get: + responses: + '200': + description: 'Returns organization details' + schema: + $ref: '#/definitions/Organization' + '401': + $ref: '#/responses/UnauthorizedResponse' + summary: Get Organization Info + operationId: Get Organization Info + description: 'This endpoint returns the organization''s info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.' + tags: + - Organization + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: OK + examples: + application/json: + message: organization profile updated successfully + schema: + $ref: '#/definitions/MessageResponse' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update Organization Profile + operationId: Update Organization Profile + description: 'Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.' + tags: + - Organization + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - in: formData + name: logo + type: file + description: 'The logo of the organization, file type must be png or jpeg.' + - in: formData + name: data + type: string + format: json + description: > + A JSON string that contains the details to update. Contains the following keys: + `organization_name` (string): the new name of the organization, + `timezone_utc_offset` (string): the new timezone offset of the organization, + `is_approval_workflow_enabled` (boolean): whether the approval workflow is enabled or not. + For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_workflow_enabled": true}' + security: + - BearerAuth: [] + /organization/logo: + get: + summary: Retrieve Organization Logo + description: 'Retrieves the logo of the organization for display in the UI navbar.' + operationId: GetOrganizationLogo + tags: + - Organization + produces: + - 'application/octet-stream' + responses: + '200': + description: OK + schema: + type: string + format: binary + /countries: + get: + summary: Get All Countries + description: 'Fetches the list of available countries to populate the dropdown box in the New Disbursement flow. The default list reflects geographic coverage of SDP-compatible wallet providers.' + tags: + - Organization + responses: + '200': + description: A list of countries + schema: + type: array + items: + $ref: '#/definitions/Country' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + produces: + - application/json + security: + - BearerAuth: [] + /assets: + get: + summary: Get All Assets + description: 'Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.' + tags: + - Organization + responses: + '200': + description: A list of assets + schema: + type: array + items: + $ref: '#/definitions/Asset' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + produces: + - application/json + security: + - BearerAuth: [] + post: + summary: Create Asset + description: 'This endpoint is used to create a new asset that can be used in a Disbursement. Note: the organization must hold a balance in a particular asset to use it in a disbursement.' + consumes: + - application/json + produces: + - application/json + tags: + - Organization + parameters: + - in: body + name: body + description: Asset to be created + required: true + schema: + type: object + properties: + code: + type: string + description: The asset code + example: 'USDC' + issuer: + type: string + description: The issuer + example: 'GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5' + required: + - code + - issuer + responses: + '201': + description: Asset created successfully + '400': + description: Bad request, invalid request body or the provided code/issuer is invalid. + security: + - BearerAuth: [] + /assets/{id}: + delete: + summary: Delete Asset + description: This endpoint is used to soft delete an asset. + produces: + - application/json + tags: + - Organization + parameters: + - name: id + in: path + description: ID of the asset to delete + required: true + type: string + responses: + '200': + description: Asset deleted successfully + '204': + description: Asset already deleted + '404': + description: Asset not found + security: + - BearerAuth: [] + patch: + summary: Update Asset + description: This endpoint is used to update the metadata of an existing asset. + consumes: + - application/json + produces: + - application/json + tags: + - Organization + parameters: + - name: id + in: path + description: ID of the asset to update + required: true + type: string + - in: body + name: body + description: Asset metadata to be updated + required: true + schema: + type: object + properties: + code: + type: string + description: The asset code + issuer: + type: string + description: The issuer + required: + - code + - issuer + responses: + '200': + description: Asset updated successfully + '400': + description: Bad request, invalid request body or the provided code/issuer is invalid + '404': + description: Asset not found + security: + - BearerAuth: [] + /wallets: + get: + summary: Get All Wallets + description: 'Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. The initial list reflects all SDP-compatible wallets.' + tags: + - Organization + responses: + '200': + description: A list of wallets + schema: + type: array + items: + $ref: '#/definitions/Wallet' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + produces: + - application/json + security: + - BearerAuth: [] + /users: + get: + responses: + '200': + description: "Returns a paginated list of User Details" + schema: + $ref: '#/definitions/Users' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Get All Users + operationId: Get All Users + description: 'Fetches all SDP users within the organization, whether they are active yet or not.' + tags: + - Users + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + post: + responses: + '201': + description: Created + schema: + $ref: '#/definitions/User' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Create User + operationId: Create User + description: 'This endpoint creates a new SDP user as the result of an SDP owner adding their information in the UI. It also handles sending the invite email.' + tags: + - Users + parameters: + - name: body + in: body + schema: + type: object + properties: + first_name: + type: string + last_name: + type: string + roles: + type: array + items: + type: string + email: + type: string + example: + first_name: John + last_name: Doe + roles: + - business + email: email@email.com + produces: + - application/json + security: + - BearerAuth: [] + /users/activation: + patch: + responses: + '200': + description: Created + examples: + application/json: + message: user activation was updated successfully + schema: + $ref: '#/definitions/User' + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update User Activation Status + operationId: Update User Activation Status + description: 'Updates the SDP user’s activation status. This endpoint is primarily used to move a user into active status when they accept the invite to join an SDP organization account and create a password.' + tags: + - Users + parameters: + - name: body + in: body + schema: + type: object + properties: + user_id: + type: string + is_active: + type: boolean + example: + user_id: 5ca230c9-da95-4bd1-b2a2-aa5d0df65efd + is_active: false + produces: + - application/json + security: + - BearerAuth: [] + /users/roles: + get: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + roles: + - developer + - financial_controller + - business + - owner + schema: + type: object + properties: + roles: + type: array + items: + type: string + example: + roles: + - developer + - financial_controller + - business + - owner + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Get All Roles + operationId: Get All Roles + description: 'Fetches available SDP roles, such as owner, financial controller, business user, and developer.' + tags: + - Users + parameters: [] + produces: + - application/json + security: + - BearerAuth: [] + patch: + responses: + '200': + description: OK + headers: {} + examples: + application/json: + message: user roles were updated successfully + schema: + type: object + properties: + message: + type: string + example: + message: user roles were updated successfully + '401': + $ref: '#/responses/UnauthorizedResponse' + '403': + $ref: '#/responses/ForbiddenResponse' + summary: Update User Role + operationId: Update User Role + description: 'Updates an SDP user’s role by ```user_ID```.' + tags: + - Users + parameters: + - name: body + in: body + schema: + type: object + properties: + user_id: + type: string + roles: + type: array + items: + type: string + example: + user_id: 5ca230c9-da95-4bd1-b2a2-aa5d0df65efd + roles: + - developer + produces: + - application/json + security: + - BearerAuth: [] +definitions: + Amount: + type: "object" + properties: + asset_code: + type: "string" + example: 'USDC' + asset_issuer: + type: "string" + example: 'GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5' + received_amount: + type: "string" + example: '100.00' + Asset: + type: object + properties: + id: + type: string + example: 'ffaec4b3-46b0-4db4-a4c4-6c3508057705' + code: + type: string + description: 'Asset code' + example: 'USDC' + issuer: + type: string + description: 'Asset issuer address' + example: 'GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + deleted_at: + type: string + format: date-time + example: '2023-06-03T10:55:51.000Z' + Country: + type: object + properties: + code: + type: string + description: 'Country code in ISO 3166 alpha-3' + example: 'UKR' + name: + type: string + description: 'Country name' + example: 'Ukraine' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + Disbursement: + type: object + properties: + id: + type: string + description: The unique identifier of the disbursement + example: '619da857-8725-4c58-933d-c120a458e0f5' + name: + type: string + description: The name of the disbursement + example: 'Disbursement Name' + country: + $ref: '#/definitions/Country' + wallet: + $ref: '#/definitions/Wallet' + asset: + $ref: '#/definitions/Asset' + status: + description: The status of the disbursement + $ref: '#/definitions/DisbursementStatus' + example: 'READY' + verification_field: + $ref: '#/definitions/VerificationField' + example: 'DATE_OF_BIRTH' + status_history: + $ref: '#/definitions/DisbursementStatusHistory' + file_name: + type: string + example: 'disbursement-feb-03-2023.csv' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + total_payments: + type: integer + description: Total number of payments + example: 10 + total_payments_sent: + type: integer + description: Total number of successful payments + example: 8 + total_payments_failed: + type: integer + description: Total number of failed payments + example: 1 + total_payments_remaining: + type: integer + description: Total number of remaining payments + example: 1 + amount_disbursed: + type: string + description: The total amount disbursed so far + example: '800.00' + total_amount: + type: string + description: The total amount to be disbursed + example: '1000.00' + average_amount: + type: string + description: The average amount per payment + example: '100.00' + + DisbursementLite: + type: object + properties: + id: + type: string + format: uuid + description: The unique identifier of the disbursement + example: "c51ba1d5-52d3-412f-a59c-6ef32d59ab43" + name: + type: string + description: The name of the disbursement + example: "disbursement-june-29" + status: + $ref: '#/definitions/DisbursementStatus' + created_at: + type: string + format: date-time + description: The creation timestamp of the disbursement + example: "2023-06-30T01:22:57.831975Z" + updated_at: + type: string + format: date-time + description: The last update timestamp of the disbursement + example: "2023-06-30T01:22:58.316511Z" + + DisbursementPagination: + type: "object" + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: "array" + items: + $ref: '#/definitions/Disbursement' + example: + pagination: + next: "/disbursements?page=3&page_limit=1" + prev: "/disbursements?page=1&page_limit=1" + pages: 4 + total: 4 + data: + id: "619da857-8725-4c58-933d-c120a458e0f5" + name: "Disbursement Name" + country: + code: "UKR" + name: "Ukraine" + created_at: "2023-02-03T10:45:51.000Z" + updated_at: "2023-02-03T10:45:51.000Z" + wallet: + id: "e2de8544-b7e2-40a9-ad40-411f70d5c4bf" + name: "Vibrant" + homepage: "https://vibrantapp.com" + asset: + id: "25923001-508a-4629-9186-c41211b2a3d0" + code: "USDC" + issuer: "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5" + status: "READY" + verification_field: "DATE_OF_BIRTH" + status_history: [ + { + "user_id": null, + "status": "DRAFT", + "timestamp": "2023-02-03T10:45:51.000Z" + }, + { + "user_id": "2ec7f1f9-add3-4e6d-9d14-bd8ac5e88872", + "status": "READY", + "timestamp": "2023-02-03T10:45:51.000Z" + } + ] + file_name: "disbursement-february-03-2023.csv" + created_at: "2023-02-03T10:45:51.000Z" + updated_at: "2023-02-03T10:45:51.000Z" + total_payments: 10 + total_payments_sent: 8 + total_payments_failed: 1 + total_payments_remaining: 1 + amount_disbursed: '800.00' + total_amount: '1000.00' + average_amount: '100.00' + + DisbursementReceiver: + type: object + properties: + id: + type: string + example: 'ec3a57c0-5660-4b5a-af76-acadc7b09b93' + email: + type: string + example: 'receiver@mail.org' + phone_number: + type: string + example: '+15552368475' + external_id: + type: string + example: 'usr129001' + receiver_wallet: + $ref: '#/definitions/ReceiverWallet' + payment: + $ref: '#/definitions/Payment' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + + DisbursementReceiverPagination: + type: "object" + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: "array" + items: + $ref: '#/definitions/DisbursementReceiver' + + + DisbursementsStatistics: + type: object + properties: + payment_counters: + $ref: '#/definitions/PaymentCounters' + payment_amounts_by_asset: + type: array + items: + $ref: '#/definitions/PaymentAmountsByAsset' + receiver_wallets_counters: + $ref: '#/definitions/ReceiverWalletsCounters' + total_receivers: + type: integer + description: Total number of receivers + format: int64 + example: 100 + + DisbursementStatus: + type: string + enum: + - DRAFT + - READY + - STARTED + - PAUSED + - COMPLETED + + DisbursementStatusHistory: + type: array + items: + $ref: '#/definitions/DisbursementStatusHistoryEntry' + + DisbursementStatusHistoryEntry: + type: object + properties: + user_id: + type: string + example: '3f351b9e-ed0f-40fa-a314-14757b42dab1' + status: + $ref: '#/definitions/DisbursementStatus' + timestamp: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + + GeneralStatistics: + type: object + properties: + total_disbursements: + type: integer + description: Total number of disbursements + format: int64 + example: 20 + payment_counters: + $ref: '#/definitions/PaymentCounters' + payment_amounts_by_asset: + type: array + items: + $ref: '#/definitions/PaymentAmountsByAsset' + receiver_wallets_counters: + $ref: '#/definitions/ReceiverWalletsCounters' + total_receivers: + type: integer + description: Total number of receivers + format: int64 + example: 1000 + + MessageResponse: + type: object + properties: + message: + type: string + required: + - message + + Organization: + type: object + properties: + name: + type: string + example: 'Stellar Aid' + logo_url: + type: string + example: 'https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo' + distribution_account_public_key: + type: string + example: 'GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL' + timezone_utc_offset: + type: string + example: '+00:00' + is_approval_workflow_enabled: + description: 'Enables multi-user approval workflow for disbursements' + type: boolean + example: true + + Pagination: + type: "object" + properties: + next: + type: "string" + example: '?page=3&page_limit=2' + prev: + type: "string" + example: '?page=1&page_limit=2' + pages: + type: "integer" + example: 8 + total: + type: "integer" + example: 16 + + Payment: + type: object + properties: + id: + type: string + example: 'ddf22f55-3259-4822-a4e2-ce01334997f4' + amount: + type: string + example: '100.00' + stellar_transaction_id: + type: string + example: '0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b' + stellar_operation_id: + type: string + status: + $ref: '#/definitions/PaymentStatus' + status_history: + $ref: '#/definitions/PaymentStatusHistory' + disbursement: + $ref: '#/definitions/DisbursementLite' + asset: + $ref: '#/definitions/Asset' + receiver_wallet: + $ref: '#/definitions/ReceiverWalletLite' + created_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + + PaymentPagination: + type: "object" + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: "array" + items: + $ref: '#/definitions/Payment' + PaymentStatus: + type: string + enum: + - DRAFT + - READY + - PENDING + - PAUSED + - SUCCESS + - FAILED + + PaymentStatusHistory: + type: array + items: + $ref: '#/definitions/PaymentStatusHistoryEntry' + + PaymentStatusHistoryEntry: + type: object + properties: + status: + $ref: '#/definitions/PaymentStatus' + status_message: + type: string + timestamp: + type: string + format: date-time + example: '2023-02-03T10:45:51.000Z' + + PaymentCounters: + type: object + properties: + draft: + type: integer + format: int64 + example: 1 + ready: + type: integer + format: int64 + example: 2 + pending: + type: integer + format: int64 + example: 3 + paused: + type: integer + format: int64 + example: 1 + success: + type: integer + format: int64 + example: 5 + failed: + type: integer + format: int64 + example: 1 + total: + type: integer + format: int64 + example: 14 + PaymentAmountsByAsset: + type: object + properties: + asset_code: + type: string + example: 'USDC' + payment_amounts: + $ref: '#/definitions/PaymentAmounts' + PaymentAmounts: + type: object + properties: + draft: + type: string + example: '100.00' + ready: + type: string + example: '200.00' + pending: + type: string + example: '300.00' + paused: + type: string + example: '100.00' + success: + type: string + example: '500.00' + failed: + type: string + example: '100.00' + average: + type: string + example: '100.00' + total: + type: string + example: '1400.00' + + Profile: + type: object + properties: + first_name: + type: string + example: 'Jane' + last_name: + type: string + example: 'Doe' + email: + type: string + example: 'jdoe@mail.org' + roles: + type: array + items: + type: string + organization_name: + type: string + example: + first_name: Jane + last_name: Doe + email: jdoe@mail.org + roles: + - developer + organization_name: Stellar Aid + Receiver: + type: "object" + properties: + id: + type: "string" + example: 'f83bb638-dda4-41e6-80c9-d03e6eec2aef' + phone_number: + type: "string" + example: '+15552368475' + external_id: + type: "string" + example: 'usr12334' + email: + type: "string" + example: 'jdoe@mail.org' + created_at: + type: "string" + example: '2023-02-03T10:45:51.000Z' + total_payments: + type: "string" + example: "2" + successful_payments: + type: "string" + example: "2" + failed_payments: + type: "string" + example: "0" + remaining_payments: + type: "string" + example: "0" + registered_wallets: + type: "string" + example: 1 + received_amounts: + type: "array" + items: + $ref: '#/definitions/Amount' + wallets: + type: "array" + items: + $ref: '#/definitions/ReceiverWallet' + + ReceiverLite: + type: "object" + properties: + id: + type: "string" + example: '029e2ed0-feb6-4c40-8b47-0836a85741a2' + + ReceiverPagination: + type: "object" + properties: + pagination: + $ref: '#/definitions/Pagination' + data: + type: "array" + items: + $ref: '#/definitions/Receiver' + + ReceiverWallet: + type: "object" + properties: + id: + type: "string" + example: '803031d4-1d04-4879-b6d9-dc5641f9988e' + receiver: + $ref: '#/definitions/ReceiverLite' + wallet: + $ref: '#/definitions/WalletLite' + stellar_address: + type: "string" + example: 'GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL' + stellar_memo: + type: "string" + stellar_memo_type: + type: "string" + created_at: + type: "string" + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: "string" + example: '2023-02-03T10:45:51.000Z' + invited_at: + type: "string" + example: '2023-02-09T10:45:51.000Z' + last_sms_sent: + type: "string" + example: '2023-02-10T10:45:51.000Z' + description: 'timestamp when the receiver last received an SMS about this wallet' + total_payments: + type: "string" + example: "2" + payments_received: + type: "string" + example: "2" + failed_payments: + type: "string" + example: "0" + remaining_payments: + type: "string" + example: "0" + received_amounts: + type: "array" + items: + $ref: '#/definitions/Amount' + status: + $ref: '#/definitions/ReceiversWalletStatus' + status_history: + type: "array" + items: + $ref: '#/definitions/ReceiversWalletStatusHistoryEntry' + + ReceiverWalletLite: + type: "object" + properties: + id: + type: "string" + example: '803031d4-1d04-4879-b6d9-dc5641f9988e' + receiver: + $ref: '#/definitions/ReceiverLite' + wallet: + $ref: '#/definitions/WalletLite' + stellar_address: + type: "string" + example: 'GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL' + created_at: + type: "string" + example: '2023-02-03T10:45:51.000Z' + updated_at: + type: "string" + example: '2023-02-03T10:45:51.000Z' + status: + $ref: '#/definitions/ReceiversWalletStatus' + + ReceiverWalletsCounters: + type: object + properties: + draft: + type: integer + format: int64 + example: 1 + ready: + type: integer + format: int64 + example: 1 + registered: + type: integer + format: int64 + example: 1 + flagged: + type: integer + format: int64 + example: 1 + total: + type: integer + format: int64 + example: 4 + + ReceiversWalletStatus: + type: "string" + enum: [ "DRAFT", "READY", "REGISTERED", "FLAGGED" ] + + ReceiversWalletStatusHistoryEntry: + type: "object" + properties: + status: + $ref: '#/definitions/ReceiversWalletStatus' + timestamp: + type: "string" + format: "date-time" + example: '2023-02-10T10:45:51.000Z' + + Users: + type: array + items: + $ref: '#/definitions/User' + User: + type: object + properties: + id: + type: string + example: '1736bed3-7b92-4760-8ff2-51fb08ee079f' + first_name: + type: string + example: 'John' + last_name: + type: string + example: 'Doe' + email: + type: string + roles: + type: array + items: + type: string + is_active: + type: boolean + required: + - id + - first_name + - last_name + - email + - roles + - is_active + example: + - id: 7a4c6555-1f73-49b3-a211-f95bd2b8ec90 + first_name: John + last_name: Doe + email: email@email.com + roles: + - developer + is_active: true + - id: 5f4df1dd-c84f-482a-84ad-541ffd46e75a + first_name: Jane + last_name: Doe + email: email@email.com + roles: + - financial_controller + is_active: false + VerificationField: + type: string + enum: + - DATE_OF_BIRTH + - PIN + - NATIONAL_ID_NUMBER + Wallet: + type: object + properties: + id: + type: string + example: '5ada9ed5-455a-4782-a0ee-160767e0deb1' + name: + type: string + example: 'Vibrant Assist' + homepage: + type: string + example: 'https://vibrantapp.com' + sep_10_client_domain: + type: string + example: 'api-dev.vibrantapp.com' + deep_link_schema: + type: string + example: 'https://vibrantapp.com/sdp-dev' + created_at: + type: string + format: date-time + example: '2023-07-31T20:50:45.648Z' + updated_at: + type: string + format: date-time + example: '2023-07-31T20:50:45.648Z' + + WalletLite: + type: "object" + properties: + id: + type: "string" + example: '5ada9ed5-455a-4782-a0ee-160767e0deb1' + name: + type: "string" + example: 'Vibrant Assist' + homepage: + type: "string" + example: 'https://vibrantapp.com' + + ReceiverRegistrationRequest: + 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 + PatchReceiverRequest: + type: object + properties: + date_of_birth: + type: string + description: Date of birth of the receiver + pin: + type: string + description: Personal identification number of the receiver + national_id: + type: string + description: National ID of the receiver + email: + type: string + description: Email of the receiver + external_id: + type: string + description: External ID of the receiver + example: + date_of_birth: "1980-01-01" + pin: "1234" + national_id: "123456789" + email: "john@example.com" + external_id: "external123" +responses: + UnauthorizedResponse: + description: Unauthorized + headers: { } + examples: + application/json: + error: Not authorized + extras: + status: 401 + message: Not authorized + 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 + ForbiddenResponse: + description: Forbidden + headers: { } + examples: + application/json: + error: Forbidden + schema: + type: object + properties: + error: + type: string + example: + error: Forbidden + BadRequestResponse: + description: Bad Request + schema: + type: object + properties: + message: + type: string + description: Details about the error + NotFoundResponse: + description: Not Found + headers: {} + examples: + application/json: + error: Not found + extras: + status: 404 + message: Resource not found + schema: + type: object + properties: + error: + type: string + extras: + type: object + properties: + status: + type: number + message: + type: string +securityDefinitions: + BearerAuth: + type: "apiKey" + name: "Authorization" + in: "header" + description: "JWT used for authentication, signed with an ES256 private key." +tags: + - name: Authentication + description: 'Authentication endpoints control the login, token refresh, and password management processes for SDP users.' + - name: Disbursements + description: 'Endpoints related to disbursements. A disbursement is a group of payments sent to multiple individuals at once. An SDP user with the appropriate role triggers a new disbursement through the SDP dashboard by uploading a list of receivers and amounts. When the receiver has linked their wallet to the SDP, the payment automatically begins. SDP users can track their disbursements in real-time through the SDP dashboard. Each disbursement must have a unique name defined by the organization.' + - name: Payments + description: 'Endpoints related to payments. An SDP payment is an individual payment from an organization to a receiver. Each payment is part of a disbursement and occurs on the Stellar network. Granular payment status is stored in the SDP database and can be viewed in real-time on the SDP dashboard. There is no POST endpoint because submitting payments to the Stellar network is handled by the Transaction Submission Service (TSS).' + - name: Receivers + description: >- + Endpoints related to receivers. A receiver is an individual receiving a payment in a disbursement. The receiver is tracked by phone number to reduce the need for personally identifiable information. Each receiver must be unique within the disbursement. + + + Each receiver will have at least one wallet associated with them. The wallet public key will remain null until the receiver registers with a wallet provider and links the wallet to the SDP through SEP-24. Receivers must verify their identity through that process, which requires the SDP to store verification information on receivers like date of birth, national ID number, or personal PIN. This information can be updated by the organization through the receiver endpoints. + + - name: Statistics + description: >- + Statistics endpoints return general aggregated data per organization, as well as disbursement-specific metrics. SDP users can use this data to monitor their disbursements over time. + + - name: Registration + description: >- + The registration endpoints guide the process for a receiver to verify their identity and link their wallet address to an SDP. + + + The registration process only needs to happen once per receiver to link their wallet. Only SDP-compatible wallet providers can facilitate the registration process. These endpoints must be supported and hit by the wallet providers after the receiver gets the initial SMS invite. After the wallet address is successfully linked, the payment automatically begins. + + + The SDP<>wallet registration process uses SEP-10, SEP-24, and deep links. Please see the SDP [developer docs](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform) for a full set of instructions for wallet providers to become SDP-compatible. + - name: Profile + description: >- + Profiles endpoints manage the process of getting and updating individual profile information. Profile information is set when the account is created and can be updated by the user on the SDP dashboard Profile page. Note: profiles never refer to receivers of funds. + + - name: Organization + description: >- + Organization endpoints manage the process of getting and updating organizational profile information. The organization’s profile has basic information set at the time of SDP deployment. It can be modified by the Owner. Organizations can also manage their preferences, like which assets to use, through these endpoints. + + - name: Users + description: >- + The users endpoints facilitate the creation of new SDP users–including setting the appropriate role, sending an email invitation, and activating a user–and managing roles. \ No newline at end of file diff --git a/package.json b/package.json index 825f08e45..36f231c22 100644 --- a/package.json +++ b/package.json @@ -11,10 +11,11 @@ "clear": "docusaurus clear", "serve": "docusaurus serve", "api:clean": "docusaurus clean-api-docs all", - "api:bundle": "yarn bundle-horizon && yarn bundle-anchor-platform", + "api:bundle": "yarn bundle-horizon && yarn bundle-anchor-platform && yarn bundle-stellar-disbursement-platform", "bundle-horizon": "redocly bundle openapi/horizon/main.yml --output openapi/horizon/bundled.yml", "bundle-anchor-platform": "redocly bundle openapi/anchor-platform/Platform\\ API.yml --output openapi/anchor-platform/bundled.yml && yarn redocly bundle openapi/anchor-platform/Callbacks\\ API.yml --output openapi/anchor-platform/bundled_callback.yml", - "api:gen": "docusaurus gen-api-docs all && rm api/horizon/resources/*.info.mdx && rm api/anchor-platform/resources/*.info.mdx && rm api/anchor-platform/callbacks/*.info.mdx", + "bundle-stellar-disbursement-platform": "redocly bundle openapi/stellar-disbursement-platform/main.yml --output openapi/stellar-disbursement-platform/bundled.yml", + "api:gen": "docusaurus gen-api-docs all && rm api/horizon/resources/*.info.mdx && rm api/anchor-platform/resources/*.info.mdx && rm api/anchor-platform/callbacks/*.info.mdx && rm api/stellar-disbursement-platform/resources/*.info.mdx", "api": "yarn api:clean && yarn api:bundle && yarn api:gen", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", diff --git a/sidebarsApi.js b/sidebarsApi.js index 20d3088c2..7e3f3727a 100644 --- a/sidebarsApi.js +++ b/sidebarsApi.js @@ -27,6 +27,18 @@ const sidebars = { ], } ], + stellar_disbursement_platform: [ + { + type: "category", + label: "Stellar Disbursement Platform API", + items: [ + { + "type": "autogenerated", + "dirName": "stellar-disbursement-platform" + } + ] + } + ] } module.exports = sidebars;