diff --git a/openapi/anchor-platform/bundled-callbacks.yaml b/openapi/anchor-platform/bundled-callbacks.yaml index 710cde518b..b49a5f820b 100644 --- a/openapi/anchor-platform/bundled-callbacks.yaml +++ b/openapi/anchor-platform/bundled-callbacks.yaml @@ -22,67 +22,6 @@ tags: [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) requests made from client applications. paths: - /unique_address: - get: - description: | - If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to - the Anchor backend every time a transaction is initiated by a client application. - - The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform - resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction. - - Here is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs - outside the platform, using Circle: - - [![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1) - summary: Generate Unique Address - operationId: genAddress - tags: - - Unique Address - x-seps: - - SEP-31 - parameters: - - in: query - name: transaction_id - description: | - The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. - If the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](https://developers.stellar.org/platforms/anchor-platform/api-reference/resources/get-transaction). - schema: - type: string - required: true - responses: - '200': - description: Success. - content: - application/json: - schema: - type: object - properties: - unique_address: - description: An object containing the unique `stellar_address:memo` pair used to identify a destination. - type: object - properties: - stellar_address: - description: A `G...` stellar address or a `M...` [muxed stellar address](https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/pooled-accounts-muxed-accounts-memos#muxed-accounts) of an **existing** account in the Stellar network. - type: string - memo: - description: The memo to attach to the Stellar payment. - type: string - memo_type: - description: The type of memo to attach to the Stellar payment (text, hash, or id). - type: string - enum: - - text - - hash - - id - required: - - stellar_address - '500': - description: Error. The Platform will respond to the client application with the same response code and body. - content: - application/json: - schema: - $ref: '#/components/schemas/Error' /rate: get: description: | @@ -433,15 +372,6 @@ paths: description: The event is invalid or rejected. The response body contains the error message. components: schemas: - Error: - type: object - properties: - error: - type: string - id: - type: string - required: - - error RateFeeDetailResponse: type: object properties: @@ -502,6 +432,15 @@ components: - price - sell_amount - buy_amount + Error: + type: object + properties: + error: + type: string + id: + type: string + required: + - error GetCustomerResponse: type: object required: diff --git a/openapi/anchor-platform/main-callbacks.yaml b/openapi/anchor-platform/main-callbacks.yaml index 81d7a33a21..5211822270 100644 --- a/openapi/anchor-platform/main-callbacks.yaml +++ b/openapi/anchor-platform/main-callbacks.yaml @@ -28,68 +28,6 @@ x-tagGroups: - Rates - Customers paths: - /unique_address: - get: - description: | - If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to - the Anchor backend every time a transaction is initiated by a client application. - - The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform - resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction. - - Here is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs - outside the platform, using Circle: - - [![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1) - summary: Generate Unique Address - operationId: genAddress - tags: - - Unique Address - x-seps: - - SEP-31 - parameters: - - in: query - name: transaction_id - description: | - The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. - If the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](https://developers.stellar.org/platforms/anchor-platform/api-reference/resources/get-transaction). - schema: - type: string - required: true - responses: - '200': - description: Success. - content: - application/json: - schema: - type: object - properties: - unique_address: - description: An object containing the unique `stellar_address:memo` pair used to identify a destination. - type: object - properties: - stellar_address: - description: A `G...` stellar address or a `M...` [muxed stellar address](https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/pooled-accounts-muxed-accounts-memos#muxed-accounts) of an **existing** account in the Stellar network. - type: string - memo: - description: The memo to attach to the Stellar payment. - type: string - memo_type: - description: The type of memo to attach to the Stellar payment (text, hash, or id). - type: string - enum: - - text - - hash - - id - required: - - stellar_address - - '500': - description: Error. The Platform will respond to the client application with the same response code and body. - content: - application/json: - schema: - $ref: './schemas.yaml#/components/schemas/Error' /rate: get: description: | diff --git a/openrpc/src/anchor-platform/methods/request_onchain_funds.json b/openrpc/src/anchor-platform/methods/request_onchain_funds.json index 5bf047b611..1abe5cf627 100644 --- a/openrpc/src/anchor-platform/methods/request_onchain_funds.json +++ b/openrpc/src/anchor-platform/methods/request_onchain_funds.json @@ -3,7 +3,7 @@ "summary": "Request onchain funds", "description": "The user has to initiate transfer to the anchor", "paramStructure": "by-name", - "tags": [{ "name": "SEP-6" }, { "name": "SEP-24" }], + "tags": [{ "name": "SEP-6" }, { "name": "SEP-24" }, { "name": "SEP-31" }], "params": [ { "$ref": "#/components/contentDescriptors/transaction_id" }, { "$ref": "#/components/contentDescriptors/message" }, diff --git a/platforms/anchor-platform/admin-guide/sep31/integration.mdx b/platforms/anchor-platform/admin-guide/sep31/integration.mdx index e9decf4abf..41e948f32c 100644 --- a/platforms/anchor-platform/admin-guide/sep31/integration.mdx +++ b/platforms/anchor-platform/admin-guide/sep31/integration.mdx @@ -14,7 +14,6 @@ Integrating with the Anchor Platform for facilitating cross-border payments invo The following may also be required depending on your use case: -- [`GET /unique_address`][get-unique-address] if your business uses a custody service for on-chain assets - [`DELETE /customer`][delete-customer] if your business wants or is required to allow senders to request deletion of customer data ## Create a Business Server @@ -240,9 +239,45 @@ This chapter also contains information about the format of [request][sep24-integ ### Ready to Receive Funds -SEP-31 Transactions should initially be in the `pending_sender` status. The Receiving Anchor waits to receive the payment identified by the stellar_memo included in the POST /transactions response. +SEP-31 Transactions should initially be in the `pending_receiver` status. To request funds from the Sending Anchor, the Receiving Anchor should change the transaction status to `pending_sender` by making the following RPC request: -Once your business detects that it has received an on-chain payment for a specific transaction, it has to update the transaction status. + + +```json +// request-onchain-funds.json +[ + { + "id": 1, + "jsonrpc": "2.0", + "method": "request_onchain_funds", + "params": { + "transaction_id": "", + "message": "Request onchain funds", + "destination_account": "GD...G", + "memo": "12345", + "memo_type": "id" + } + } +] +``` + + + +To execute this, you need to run: + + + +```bash +./call-json-rpc.sh request-onchain-funds.json +``` + + + +The transaction status will be changed to `pending_sender`. + +### Funds Received + +If the Sending Anchor has sent the funds, the Receiving Anchor should change the transaction status to `pending_receiver` by making the following JSON-RPC request: @@ -616,36 +651,12 @@ assets: -## Unique Address Callback Endpoint - -Businesses must provide a unique Stellar account and memo pair for each transaction requested by sending organizations so that the Anchor Platform can identify and map the on-chain payment sent for the specific transaction. The Anchor Platform can generate these account & memo pairs itself, but most businesses use a custodial service to receive on-chain payments. In this case, the business must request the custodian to generate the Stellar account & memo. This is done by using the [`GET /unique_address` endpoint][get-unique-address]. - -### Configuration - -To configure the Anchor Platform to make these requests, add the following to your configuration: - - - -```bash -# dev.env -SEP31_DEPOSIT_INFO_GENERATOR_TYPE=api -``` - - - -:::caution - -This endpoint may be removed during future major version updates of the Anchor Platform, when it adds support for connecting to custodial services and generating these addresses automatically. - -::: - [ap-api]: ../../README.mdx [ap-sep10]: ../sep10/README.mdx [sep12]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md [demo-wallet]: https://demo-wallet.stellar.org [indicative]: https://www.investopedia.com/terms/i/indicativequote.asp [firm]: https://www.investopedia.com/terms/f/firmquote.asp -[get-unique-address]: ../../api-reference/callbacks/gen-address.api.mdx [get-customer]: ../../api-reference/callbacks/get-customer.api.mdx [put-customer]: ../../api-reference/callbacks/put-customer.api.mdx [get-rate]: ../../api-reference/callbacks/get-rates.api.mdx diff --git a/platforms/anchor-platform/api-reference/callbacks/README.mdx b/platforms/anchor-platform/api-reference/callbacks/README.mdx index 18549fe194..1abac748cf 100644 --- a/platforms/anchor-platform/api-reference/callbacks/README.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/README.mdx @@ -9,13 +9,12 @@ The Anchor Platform provides several callback functionalities for your business -| | | -| ------ | ---------------------------------------- | -| GET | [/customer](./get-customer.api.mdx) | -| PUT | [/customer](./put-customer.api.mdx) | -| DELETE | [/customer/:id](./del-customer.api.mdx) | -| POST | [/event](./post-event.api.mdx) | -| GET | [/rate](./get-rates.api.mdx) | -| GET | [/unique_address](./gen-address.api.mdx) | +| | | +| ------ | --------------------------------------- | +| GET | [/customer](./get-customer.api.mdx) | +| PUT | [/customer](./put-customer.api.mdx) | +| DELETE | [/customer/:id](./del-customer.api.mdx) | +| POST | [/event](./post-event.api.mdx) | +| GET | [/rate](./get-rates.api.mdx) | diff --git a/platforms/anchor-platform/api-reference/callbacks/del-customer.api.mdx b/platforms/anchor-platform/api-reference/callbacks/del-customer.api.mdx index 07d817a0eb..c9007b0b66 100644 --- a/platforms/anchor-platform/api-reference/callbacks/del-customer.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/del-customer.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,60 +34,102 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Delete Customer Data"} -> +> + + + + + - -The request for this endpoint is identical to the [`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) request defined in SEP-12. + +The request for this endpoint is identical to the +[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) +request defined in SEP-12. Delete the customer's data or queue the customers data for deletion. + +> +
- -

+ +

Path Parameters

-
-
+

    + param={{"in":"path","name":"id","schema":{"type":"string"},"required":true}} + > + +
-
-
+
- - -
Success.
-
-
- -
Customer not found.
+ + +
+ + + Success. + + +
+ +
+
- - - - + + + Customer not found. + + +
+ + + +
- Schema - -
-
    + + Schema + +
    + +
      - + + + schema={{"type":"string"}} + > + +
-
- + > + +
diff --git a/platforms/anchor-platform/api-reference/callbacks/gen-address.api.mdx b/platforms/anchor-platform/api-reference/callbacks/gen-address.api.mdx deleted file mode 100644 index d294ffb4ab..0000000000 --- a/platforms/anchor-platform/api-reference/callbacks/gen-address.api.mdx +++ /dev/null @@ -1,259 +0,0 @@ ---- -id: gen-address -title: "Generate Unique Address" -description: "If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to" -sidebar_label: "Generate Unique Address" -hide_title: true -hide_table_of_contents: true -api: eJztWFlz6joS/isa34c5OYVZQwK8cYBwCIQQtpCtiJAaW2BLRpIBJ5X/fks2JGS5d6amZh6mKnlJIrW7W+pF39fPFgVFJAs0E9yqWK050i6gwMN6LqSPmEJE8DlzQgkUbZh20SOFQCimW3wumsBBYi3kMAqggnDAHlOxgt5egY+XgLTLFJKwCkFppMU9NyJVTlwh0QyTJXCKYA0yQpr5gDDSEnOFiXHKuMA40wxroGgWIYyIx4BrhIPAYwQbofQ9v+fDN6V+qDRyQiwx12DsYx275YMvkAQdSg4UMf7eM6ZQyNkqhBRSAjGNCOZoBsjHQQAU5Wwt7BzSAuHX891zCUqEkgBSIXERVgiju0GjZxdyDz9crQNVyWSUBs/DMi2kkwmk0IIIL6MgsAu5o8Ozxsf4DRKMK67YJO7NPbFBGxF61DgTKqBoLiTqAwG2ZtzZHVolx+QA1PhIJGBtjg5M7o6FHn9gQkTIdSq+iaNHFGAm1T0XoVaMwrvYp1CojPYak8SDinHt7h93b4fyQfqY0TTjywzznUyAl6IC3ZU3JjrMP1Wvpuejs2GUY5cbN2qUqyM3DLOX/avczZr6rXb9fDwa3LS86wFzGzfTNYT9i7Dn/sbDcY2Ux4te/Ri20dPNYBzVO35pZHf7YbWw7ZdoxybNk6pY4YutcxmcZuVJ2SnKxXZS7Xt1ul2Fx+1xzZlc5MfBRvYp6bRgGJZy3qx/5fYm1eD3RExvt83gmB0LMQjC6nJTxypHj50LvCKbRb2VFbPLzmlQUKPV+Yko1rsX3apdpDAprrxuq2VfN7brhe13xlNSuOwfK88p+erEOZ38PlkHK7Ll+cnaad1EYe180HP4r/zm+Next2w13as2y+drNRXR8eJ0wupndhO3T67r5fbEG86Xw41oqnnpnKzrNyvHni7ydHk2r+ccOKtHg2LgzfKjrM/r/VYt23NIt3Z92hj9GpOmXtXqvdFKnZYv19PbQQk2Ue5ie3whWbUtpk9Fv00vb7xbhgEuyl5Y3Iy9cifH87f85MottkazYvual6OT6/z1qFOsD0aDNb2VZ+fb05msO1GvTmkJjsEf5Ton21M+l0+82xsu+p2u9p/CKp/kO5O8Gk4n7dZ5YTTdzubli1nhmrbqTad2XmQlp9WuecXxWa11rqFEbK80WaxhUco3+ZZ2cTMa/Sb5aSnXWNzOSM/tdzZP4Sh/dXqzbY8WS9loeUs3u4iqZVZak3KwXd/iM5qvXUZ2bdYvF1i9PsB+uRC63V6zbpPF5LQaBroxI8AbOXqOPft2sBr1et2+XTr/vZzmi/3r4/aQNW36ZBfEQDzxKPt0vl2c9cUZy49/NW019XJRd3p7sZou2+VeKXt1+lSFcNsIvV+DYbDMbQo2Pzsrs8nldRYXGrxLTroX86W7XC2i/GXg8JGKTnk+37ws1fnsZFYddpxVuG2XBeS64eppXFrnO63c0eea8tgaMkCZ/uO7qr6r6ruq/pOquudWyhKBwSdM8Ba1KpYDvEqpBKWslKWxo6zKnTVK3sb9xkPK2toKgngvecjNWoAl9kGDNOvPFjNgaRWCjKyUxbEPVsU6eMinjFqpD9BqeIirFMg1SLRhnocUXu9eXqEMxjkEP5hTFGCl4v3H9xYekXalCB03gQnAaSAY1+l7vkNxOAFDG6ZcUAYTJMjn0IBNIQBODZxKMMIUJ/eQOtTg4wjFh40X7x6bjSHKHGhRj6/WkZi/B4DVXuutv1FYg2diotLvMNFOWGUSg/Z+IYMDZkuYgwROILPHWirjgLYPHDhKx9FWxAUfW5VnS0eBCYnSknHHeklZBuMxCdSqaBnCy4NZUYHgCpSRz2ez5tf7iA1CQkCptJWyiOAauDYyB7Azs1BG8PmzYTFbANFWygqkOa5miZn3d/zZYpWj5EuDujVm3AAwc517ALe7tb2GioFxCYpLgKEWiJlosrkByhSUZjxByCbj/9a3D6q/cA49NtPp9CPaSaKdJBISYfR4Ee/d+eEW6EeRf5kBVBCV8QBLngFOImJEKMPvksxWARCGPfYENBMI4QG1d3hW2bHZg3/BF+qP94tHJjcxRz9/wpaZi3F+/kS7zYQLABrs/OagN0IuD27tLZWM7s+3M9zTC8MPtMbENX8d6gxw5APXf6lzmqx+pdjsGO//LQPoh4atTiEXKzdlgsPo0WejKQt46JsmZ6StlGXErZTFqPXw8q5g7j6lxsNL/JOyil+VTUNKIdNoeNgF4kaXVBzdu/2ZxiUE0+wp7APaVygigkLcCmeCRv/FcgTj6ZftgtEvlj/cSvL1Q8rSTHuwP7i1uxrYauDK5G38YCwhsir7lyVlrbEXwuELYzqSD9oVyTsV+4q1a1WszIemkbKSxyPRG0rPqlj76iLY8wyhTs8MdwOl7EQ2DVvsBx4k7TVNhG8Zg4zP40w22pLYFdLZdPbLp2sQceJKwUWoUG1nRpnujuKynO9DaKjpYVLuGPlrJgRSmFi8Mva/1kthbs6wp+cK+ZiCmQC8e182LvPAkHWmjG7TsE3TxK+sfi6F//XQwKToPU/u5J/qNd3ULkEVvJnG87npyu8sf5T/ei5hveXH2/EGcVSslOUxAlzFVb9DEdUAExdQPg7DW3Qrmcxms0njeDdumbtPVabTqjW6g4adT2fTrva9OFENlvAxP1C8m9UA+gB4PgT7+a24vqdB39Og72nQN2/95q3f06Dvqvquqv/nqkqAWILnDeExMwfGDdSPMdbzDm3ffaToDynLFUqbnefnGVYwkt7Li1lOpj8Gg1Om8MwzpGCOPQV/A6h+9Hf84Qh9j4P+5+OgL8OdELFPs7odIbNiXrTGkpmIWpW7h5eU5QKmIA9oXJUQCPTBV59I6Ds612wMrZeXPwEbr0K4 -sidebar_class_name: "get api-method" -info_path: platforms/anchor-platform/api-reference/callbacks/callbacks-server -custom_edit_url: null -hide_send_button: true ---- - -import { SepBadge } from "@site/src/components/SepBadge"; - - - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import Heading from "@theme/Heading"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - - - - - -If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to the Anchor backend every time a transaction is initiated by a client application. - -The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction. - -Here is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs outside the platform, using Circle: - -[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1) - - - -
- -

- Query Parameters -

-
-
-
    - -
-
-
-
-
- - -
Success.
-
- - - - -
- - Schema - -
-
    - -
    - - - - unique_address - - - object - - - -
    -
    - An object containing the unique - `stellar_address:memo` pair used to identify a - destination. -
    - - - -
    -
    -
    -
-
-
- - - -
-
-
-
-
- -
- Error. The Platform will respond to the client application with the - same response code and body. -
-
- - - - -
- - Schema - -
-
    - - -
-
-
- - - -
-
-
-
-
-
-
-
diff --git a/platforms/anchor-platform/api-reference/callbacks/get-customer.api.mdx b/platforms/anchor-platform/api-reference/callbacks/get-customer.api.mdx index 932d7ad907..ff0512b724 100644 --- a/platforms/anchor-platform/api-reference/callbacks/get-customer.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/get-customer.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,131 +34,133 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Retrieve Customer's Info"} -> +> + + + + + - -The request and response for this endpoint is identical to the [`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) request and response defined in SEP-12. + +The request and response for this endpoint is identical to the +[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) +request and response defined in SEP-12. This endpoint allows clients to: -1. Fetch the fields the server requires in order to register a new customer via a SEP-12 [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request + 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 +[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request + +If the server does not have a customer registered for the parameters sent in the request, it should return the +fields required in the response. The same response should be returned when no parameters are sent. -If the server does not have a customer registered for the parameters sent in the request, it should return the fields required in the response. The same response should be returned when no parameters are sent. + 2. Check the status of a customer that may already be registered -2. Check the status of a customer that may already be registered +This allows clients to check whether the customers information was accepted, rejected, or still needs more info. +If the server still needs more info, or the server needs updated information, it should return the fields required. -This allows clients to check whether the customers information was accepted, rejected, or still needs more info. If the server still needs more info, or the server needs updated information, it should return the fields required. +> +
- -

+ +

Query Parameters

-
-
+

    - + + - + + - + + - + + - + + - + + + param={{"in":"query","name":"lang","description":"Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and\nmessages should be in this language.\n","schema":{"type":"string"}}} + > + +
-
-
+
- - + +
- Valid request. Customer either already exists or the customer - identified by the parameters is new and must provide the field values - described in the response body. Response bodies are identical to the - schema defined in - [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get). -
-
- - - - + + + Valid request. Customer either already exists or the customer identified by the parameters is new and must + provide the field values described in the response body. Response bodies are identical to the schema defined + in [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get). + + + +
+ + + +
- Schema - -
-
    + + Schema + +
    + +
      - + + - + qualifierMessage={"**Possible values:** [`ACCEPTED`, `PROCESSING`, `NEEDS_INFO`, `REJECTED`]"} + schema={{"type":"string","enum":["ACCEPTED","PROCESSING","NEEDS_INFO","REJECTED"]}} + > + +
      - - - + + + fields - - - object + + object - -
      +
      - - + + property name* - - + > + + - -
      +
      - + + - + + - + + + schema={{"type":"boolean"}} + > + +
- - +
- - - + + + provided_fields - - - object + + object - -
+
- - + + property name* - - + > + + - -
+
- + + - + + - + + - + + - + + + schema={{"type":"string"}} + > + +
- - + schema={{"type":"string"}} + > + + - - - - + > + + + - The case when a customer has been successfully KYC'd and - approved - - + > + +
- - -
Error.
+
- - - - + + + Error. + + +
+ + + +
- Schema - -
-
    + + Schema + +
    + +
      - + + + schema={{"type":"string"}} + > + +
-
- + > + +
-
- -
Not Found.
+
- - - - + + + Not Found. + + +
+ + + +
- Schema - -
-
    + + Schema + +
    + +
      - + + + schema={{"type":"string"}} + > + +
-
- + > + +
diff --git a/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx b/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx index 1748e32b30..3d0b42cf2a 100644 --- a/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/get-rates.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,21 +34,38 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Retrieve Rates"} -> +> + + + + + + + - +Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must +use exchange rates that are communicated to the client application requesting the transaction. When clients make +requests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it. -Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must use exchange rates that are communicated to the client application requesting the transaction. When clients make requests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it. +Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or +[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the +client requests a firm rate. -Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or [firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the client requests a firm rate. +Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter +for this reason. -Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter for this reason. +Either `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way, +either `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either +`sell_asset` or `buy_asset` is a Stellar asset. -Either `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way, either `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either `sell_asset` or `buy_asset` is a Stellar asset. Upon receiving the response, the Anchor Platform will validate the amount and price of the response. -If the validation fails, the Platform will respond to the client application's request with a HTTP status code of `502 Bad Gateway`. +If the validation fails, the Platform will respond to the client application's request with a HTTP status +code of `502 Bad Gateway`. The `sell_amount`, `buy_amount`, `price`, and `fee` are validated as follows: @@ -56,147 +73,122 @@ The `sell_amount`, `buy_amount`, `price`, and `fee` are validated as follows: - `rate.fee.asset` must have a positive value of `significant_decimals` defined in the asset configuration. - `rate.fee.total` must equal to the sum of `rate.fee.details.amount`. - if the `rate.fee.asset == rate.sell_asset`, `sell_amount ~= price * buy_amount + fee` must hold true. - - if the `rate.fee.asset == rate.buy_asset`, `sell_amount ~= price * (buy_amount + fee)` must hold true. + - if the `rate.fee.asset == rate.buy_asset`, `sell_amount ~= price * (buy_amount + fee)` must hold true. - if `rate.fee` does not exist, `sell_amount ~= price * buy_amount` must hold true. -The `~=` is defined as equality within rounding error. The rounding error is defined as `10^(-significant_decimals)` +The `~=` is defined as equality within rounding error. + The rounding error is defined as `10^(-significant_decimals)` + +> +
- -

+ +

Query Parameters

-
-
+

    - + + - + + - + + - + + - + + - + + - + + - + + - + + + param={{"in":"query","name":"buy_delivery_method","description":"The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `sell_delivery_method`.\n","schema":{"type":"string"}}} + > + +
-
-
+
- - -
Success.
+ +
- - - - + + + Success. + + +
+ + + +
- Schema - -
-
    - + + Schema + +
    + +
      +
      - - - + + + rate - - - object + + object - -
      +
      - + + - + + - + + - + + - + + @@ -298,54 +289,52 @@ The `~=` is defined as equality within rounding error. The rounding error is def style={{}} className={"openapi-markdown__details"} > - - + + fee - - - object + + object - -
      +
      - An object describing the fees added on top - of the rate provided via the `price` - attribute. -
      - - + + - + + @@ -353,84 +342,61 @@ The `~=` is defined as equality within rounding error. The rounding error is def style={{}} className={"openapi-markdown__details"} > - + details - - - object[] + object[] - -
      +
    • Array [
      -
    • - - + + - + + -
    • + schema={{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}} + > + +
    • ]
      @@ -446,36 +412,51 @@ The `~=` is defined as equality within rounding error. The rounding error is def
-
- + > + +
-
- -
- Unprocessable Entity. This status should be returned when the anchor - understood the request but cannot return a success response. In these - cases, the Platform will respond to the client application's request - with a `400 Bad Request` and include the error message provided by the - anchor in the response body. -
+
- - - - + + + Unprocessable Entity. This status should be returned when the anchor understood the request but cannot + return a success response. + In these cases, the Platform will respond to the client application's request with a `400 Bad Request` + and include the error message provided by the anchor in the response body. + + + +
+ + + +
- Schema - -
-
    + + Schema + +
    + +
      - + + + schema={{"type":"string"}} + > + +
-
- + > + +
-
- -
- Error. The Platform will respond to the client application with the - same response code and body. -
+
- - - - + + + Error. The Platform will respond to the client application with the same response code and body. + + +
+ + + +
- Schema - -
-
    + + Schema + +
    + +
      - + + + schema={{"type":"string"}} + > + +
-
- + > + +
diff --git a/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx b/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx index 35fe34a235..522b6602b6 100644 --- a/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/post-event.api.mdx @@ -5,7 +5,7 @@ description: "Receive a JSON object representing an event." sidebar_label: "Receive an Event" hide_title: true hide_table_of_contents: true -api: eJydWEtv4zgS/isEL32RH3ns7EC37iAD9GC2OzvOXiYJFFosWeyWSDWLimMY/u+LIilbchzHSS6OyHqxWI+vuOZOLJCnd/z6CbRD/pDw5xFC49dm1zej33jif88v4z8XZ0RkGrDCKaO/Sp7yxqDzAnjCJWBuVUN7POV/Qw7qCZhgf86+f2Nm/gNyxyw0FhC0U3rBhGZAvON7zRNu4VcL6L4YueLpmudGO5KbrrlomkrlXunkB5L0Nce8hFrQf27VAE95UMAT3lgy0SlA2lWyR4POKr3gmyQu7G8kHHRbkwOcFRpFTiqz3IJwIHkyWEUnXItZXgq98Ju/WuOgR5y36EwNNmsb6Zce9l10WwLriQzOYGTSmF0JzebAjAZmCuZKYIWpKrNUepHe6xF7PGDhIxsxMZC4FMjiJnOlNe2i9LJm1zcMtGyM0g7HjAxpxKoyQjKFTGlP1FfxyAoFlRy/UD10A1lArGGVLB/aU5I9gfTdWgf+DUf1S4NDPinRHfDid/b55uurajzvToEPClUDOlE3hyKjMLYWjqecLnNEpMQSBb8dh71T0afR8L3g6d1LNkoDZUFSFCqKI4SGJ/yn0v7DO5YnXNSm1S6D5wbyEG8S0CntsyQTeU7bgcE6kJlwFH9OuYq03e6smV3fnF/yTfJhS07RcHHGNw+bmCMfTlqEqsrCwY/sI8Lh7Xm7Osbtt19lhudGWUA65enBYVV+oMpQpBknquz1fR/Oxh7y1LCEzBxUlbBf5SdkwkIss8hcKRxTkgptsaJUH7UIFpnQkoVazmagJVXhzzovjcWEzVvHtHHdfijgPYrxvb7XfxjLhCc5O2ddiUtCSikZ84lhadpKUgHDtihUrnxhM6xoq2q1s4u4OhldYs5bVBoQP7EvIv8JWu6pfWF5VB5D/tEf8bGG2kRjsGdNi7Av7zdmLAt97uMCT4rgQ+Xf+ywW+K0nLCwUOrC9oh0cPqbY6HL7TfnXypVgQzkMYcIiLx35P+0zyO2CkNICYmeK0aO8FEozuii38nrJA6cdiijZk6ha2F61b/e7Ey6VK5lgWAq7MyJhyxIshAYy2KG6vb2PMd9sdnVmmwA+rXqN6ZUaEhvFO/K4p+y/vnxtdr39g6WsJ/Kqk7TZ0PKLmus5d32m36R61TZAsE4ENkZjUH8+ndLPyzsKWEMhwzbPATFkZmMNfZDntWQWhFxR2tqI5TQ8uwjZfFvtVLG5kSsSBnUTo+XyTcVKP4lKSYpFCz98FzsklXCgUBp9WIC1xrIaEMUCQiDAswONymj07fQnrHjaIdmE+yg8img3DxTarjQdnPXediVP+QQiskWwT2CDgtZWPOWlcw2mk0kuqmou8p/jrmyNAu0YnkXdVCB8RRnnpuakiNDr3zucex2IujjZxWGMl1dQ6A6m8PPp+eXobDqa/vv27F/pdJpOfx9fXkz/4UNoMgQfQ13U1VPufeJbe8olNAaV2zX5lCudGzLVwc66rYR9LEKQPfbZHlForb1UjGxKv5PBtO5UjgIgk+CEqgIIo7Z7hIOKWSS+W3Mt6gPHfL30dWq3QCfbc/QOKB29uDgvvEnX3cjblP7+C7BZTOQTbECwWYy8riZl89VxppiX/TNbKFotcXdfWVh5d5QUAKdyNGJV+5GWLnF4BUpm2+D1faN3rSdH1KmkcaA9wdudT94g9JEVDc96OX3opKFbD7+7szt4puTut8Jj1oF+gsoMU/6Ij+NWpyx+Uvyb1uawnU2GefRidDmQeKe4feML+odVUTexWlTZPpQ43bNMSZpzy+29ZvscveVXGPOKEHMmTS2U7rPGjf3S1OERn2gIWgZoMjT8wHGHlvmY9QXiQ9zDueUD3NvpcL9B9ca+/eX9At4f8vZW90n7I93RRhrGtF537k9vvUv4+OFfQtc9sW/XhiEo7YvwqFDpwqN3wjGhXV2Mp+PpQfw+W+m8tEabFtlVBDhIjykMG8hVEd/iWGGG00UYn9hNJRwBaUKThOv8wHVcroSC0BOLJRNZLSSweZgQt/KWpaqAKY8eI1INc0VkY4U1NY0ZPklY79nQA8t7HdDYJ9xCTCR060pA2KkWRUEvlQPN+/SHVPgpcAvrt8ebeTzIE16pHDT6+I7p+7kReQns3F/DDlemk8lyuRwLvzs2djGJrDj56+vV9bfZ9eh8PB2Xrq582hBorYXuCd6+vWp28HG297r6/nfaXsWaNBXVp020fh2B8x0PwPkh4SUB6vSOr9dzgfA/W202tPyrBbvi6d0DIXSrxJycdkftrQThi9cWyl8FS0e3YRCKgP7lm/AAx998n91S2se35NpI4rFiSdVXLHnKOb1kx+a5DmtrXgm9aAOCCTLp7//XhuR0 +api: eJydWFtT4zgW/isqvfSL40Bgemb91kOxVb21O81M2JcByijWcaxuW3JLMiGVyn+fOpJ8JYQAL8HSuenoXL6jHbVsbWhyR6+fQFpDHyL6PDNQu7Xl9c3sM43c7+Iy/HNxjkSqBs2sUPIrpwmtlbFOAI0oB5NpUeMeTehfkIF4AsLIf5bf/iBq9R0ySzTUGgxIK+SaMEkAeeN7SSOq4WcDxv6u+JYmO5opaVFusqOsrkuROaXz7wal76jJCqgY/me3NdCEegU0orVGE60Ag7uCD2iM1UKu6T4KC9ONiIJsKnSA1UwalqHKNNPALHAajVaNZbYxaVYwuXabPxtlYUCcNcaqCnTa1NwtPUxddFsAGYj0ziBoUkyumCQrIEoCUTmxBZBclaXaCLlO7uWMPB6w8JHMCBtJ3DBDwiaxhVbNunCyltc3BCSvlZDWxAQNqdm2VIwTYYiQjmio4pHkAkoev1A9dgNagKx+FS0f21OgPZ703VpH/vVHdUujQz4J1h7w4jfy5ebrq2ocb6/ABYWowFhW1YciI1e6YpYmFC9zhqTIEgS/HYeDU+GnkvAtp8ndSzZMA6GBYxQKjCMDNY3oDyHdh3MsjSirVCNtCs81ZD7eOBgrpMuSlGUZbnsGbYGnzGL8WWFL1HbbW7O8vllc0n30YUtO0XBxTvcP+5AjH05aA2WZ+oMf2TcGDm+vmu0xbrf9KjM810KDwVOeHhxaZAeqDEaasqxMX9934az0IU+NS8jSQlky/ZV/MoRpCGXWEFswSwTHQptvMdVnjQFtCJOc+FpOliA5VuEvMiuUNhFZNZZIZdt9X8AHFPG9vJf/VpowR3K+IG2Ji3xKCR7yiZhCNSXHAmaaPBeZcIVNkbwpy21vF3K1MtrEXDVGSDDmE/mdZT9A8onaF5YH5SHkH90RHyuoVDDGDKxpDEzlfSZKE9/nPi7wpAg+VP6dz0KB7zyhYS2MBT0o2t7hMcZGm9tvyr8WtgDty6EPExJ48cj/a56BdwuMcw3GtKYoOcsKJiTBi7Jbpxc9cNqhkJI8sbKB7qpdu+9PuBG2IIyYguneiIhsCtDgG8hoB+t2dx8x3e/7OtMlgEurQWN6pYaERvGOPB4o+9OVr33f2z9YygYir1pJ+z0uv6i5jrPvM8MmNai2HoK1IkytpPHqF2dn+PPyjjzWEIaYJsvAGJ+ZtVb4gZ6XnGhgfItpqwOWk/BsA2RzbbVVRVaKb1EYVHWIlss3FQv5xErBMRY1fHdd7JBUxIFMSOPCArRWmlRgDFuDDwR4tiCNUNK4dvoDtjRpkWxEXRQeRbT7BwxtW6gWzjpv24ImdA4B2RrQT6C9gkaXNKGFtbVJ5vOMleWKZT/itmzNPG0Mz6yqS2CuosSZqigqQvT6V49zrz1RGyd9HIZ4eQWF9jCFLs4Wl7Pzs9niX7fnvyaLi+R8EZ9/vvybjqHJGHyMdWFXT6jziWvtCeVQKyNs3+QTKmSm0FQLvXWdhCkWQcge+uyAyLfWQSoGNiHfyaAaeypHDpBysEyUHoRh2z3CgcUsEN/tqGTVgWO+XvpatR3QSSeO7oHS0YsL88KbdO2NvE3p7j8HnYZEPsEGAzoNkdfWpHS1Pc4U8nJ4Zg15I7np7yv1K++OkhzgVI6abSs30uIljq9A8LQLXtc3Btd6ckSdShoG2hO83frkDUIXWcHwdJDTh07qu/X4uz27hWdM7mErPGYdyCco1Tjlj/g4bLXKwifGv2p0Bt1sMs6jF6PLgcQ7xe17V9A/rAq7iZasTKdQ4nTPEsFxzi26e02nHIPlVxizEhFzylXFhByyho1paWrxiEs0A5J7aDI2/MBxx5a5mHUF4kPc47nlA9zddDhtUIOxb7o8LeDDIW+yOiUdjnSvxP8vrpH6MW3QnYfT2+ASPn74l9B1IvZ4mv7y9xSUDkU4VChk7tA74hjfri7is/jsIH5fbmVWaCVVY8hVADgGH1OIqSETeXiLI7kaTxd+fCI3JbMIpBFNIq5zA9dxuRxyRE8klExDKsaBrPyE2MnbFKIEIhx6DEjVzxWBjeRaVThmuCQhg2dDByzvpUdjn0wHMQ2iW1uAgV41y3N8qRxpntIfUuGmwA7Wd8dbOjxII1qKDKRx8R3S90vNsgLIwl1DjyuT+Xyz2cTM7cZKr+eB1cz/+/Xq+o/l9WwRn8WFrUqXNghaKyYHgru3V0kOPs4OXlff/047qFjzusT6tA/W7wJwvqMeOD9EtEBAndzR3W7FDPxfl/s9Lv9sQG9pcveACF0LtkKn3WF7K4C54tVB+Stv6ezWD0IB0L98Ex7h+Jtvy1tM+/CWXCmOPJptsPqyDU0oxZfs0Dx3fm1HSybXjUcwXib+/QNIuuTk sidebar_class_name: "post api-method" info_path: platforms/anchor-platform/api-reference/callbacks/callbacks-server custom_edit_url: null @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,91 +34,148 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Receive an Event"} -> +> + + + + + + - Receive a JSON object representing an event. + +> + - - + +
- -

+ +

Body

-
-
-
    +

+ +
    - + + - + + - -
    - - - payload - object - - required + schema={{"type":"string","format":"date-time"}} + > + + +
    + + + + payload + + object + + + + required + - -
    - -
    - - transaction - object - -
    -
    - oneOf - +
    + +
    + + + transaction + + object + +
    + +
    + + oneOf + - + + - + + - + + - + + - + schema={{"type":"string","description":"This field is always empty for SEP-24 transactions."}} + > + +
    - - - + + + amount_expected - - - object - - + object + - + > + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - - - + + + amount_in - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - - - + + + amount_out - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - - - + + + fee_details - - - object + + object - -
    +
    - + + - + + @@ -347,7 +430,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -355,56 +440,51 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > details - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -414,79 +494,96 @@ Receive a JSON object representing an event.
  • - - - + + - + + - + + - + + - + + - + + - + schema={{"type":"string"}} + > + +
    - - - + + + refunds - - - object + + object - -
    +
    - + @@ -503,33 +602,37 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > amount_refunded - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -537,7 +640,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -545,33 +650,37 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > amount_fee - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -579,7 +688,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -587,47 +698,40 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > payments - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + @@ -635,47 +739,47 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + amount - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -683,75 +787,67 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
- - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -761,100 +857,85 @@ Receive a JSON object representing an event.
  • - - +
    - - - + + + stellar_transactions - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -862,7 +943,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -870,86 +953,66 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > payments - - - object[] - - + object[] + - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + @@ -957,204 +1020,190 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + amount - - - object - - - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • - -
  • +
  • ]
  • - - - + + - + + - + + - + + - + + - + + - + + - + + - + schema={{"type":"string"}} + > + +
    - - - + + + customers - - - object + + object - -
    +
    - The user that initiated the transaction is both - the sender and receiver. -
    - + + + The user that initiated the transaction is both the sender and receiver. + + + +
    @@ -1162,7 +1211,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -1170,70 +1221,61 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > sender - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer - in the business' Backend. For a SEP-31 - Sending Anchor, the `account` and `memo` - fields should be used. For a SEP-6 or - SEP-24 Anchor, the `account` and `memo` - fields should be used. -
    - + + + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. + + For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used. + + + +
    - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    - - @@ -1241,7 +1283,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -1249,145 +1293,137 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > receiver - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer - in the business' Backend. For a SEP-31 - Sending Anchor, the `account` and `memo` - fields should be used. For a SEP-6 or - SEP-24 Anchor, the `account` and `memo` - fields should be used. -
    - + + + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. + + For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used. + + + +
    - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    - - +
    - - - + + + creator - - - object + + object - -
    +
    - StellarId's are objects that identify end-users - and SEP-31 Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 customer, the - `id` field should be sufficient to fully - identify the customer in the business' Backend. - For a SEP-31 Sending Anchor, the `account` and - `memo` fields should be used. For a SEP-6 or - SEP-24 Anchor, the `account` and `memo` fields - should be used. -
    - + + + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. + + For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used. + + + +
    - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -1397,202 +1433,235 @@ Receive a JSON object representing an event. required={true} schemaName={"string"} qualifierMessage={undefined} - schema={{ type: "string" }} - > - + + - + + - + + - + + - + schema={{"type":"string","description":"This field is always empty for SEP-31 transactions."}} + > + +
    - - - + + + amount_expected - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - - - + + + amount_in - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - - - + + + amount_out - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - - - + + + fee_details - - - object + + object - -
    +
    - + + - + + @@ -1600,7 +1669,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -1608,56 +1679,51 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > details - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -1667,79 +1733,96 @@ Receive a JSON object representing an event.
  • -
    - - + + - + + - + + - + + - + + - + + - + schema={{"type":"string"}} + > + +
    - - - + + + refunds - - - object + + object - -
    +
    - + @@ -1756,33 +1841,37 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > amount_refunded - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1790,7 +1879,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -1798,33 +1889,37 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > amount_fee - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1832,7 +1927,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -1840,47 +1937,40 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > payments - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + @@ -1888,47 +1978,47 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + amount - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1936,75 +2026,67 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -2014,100 +2096,85 @@ Receive a JSON object representing an event.
  • -
    - +
    - - - + + + stellar_transactions - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -2115,7 +2182,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -2123,86 +2192,66 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > payments - - - object[] - - + object[] + - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + @@ -2210,209 +2259,191 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + amount - - - object - - - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • - -
  • +
  • ]
  • - - - + + - + + - + + - + + - + + - + + - + + - + + - + schema={{"type":"string"}} + > + +
    - - - + + + customers - - - object + + object - -
    +
    - The Identification info of the sending and - receiving customers. If they were created - through - [SEP-12](https://stellar.org/protocol/sep-12), - this object should contain the SEP-12 customer - `id`. Otherwise, the `account` address of the - customer. -
    - + + + The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12), + this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer. + + + +
    @@ -2420,7 +2451,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -2428,70 +2461,61 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > sender - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer - in the business' Backend. For a SEP-31 - Sending Anchor, the `account` and `memo` - fields should be used. For a SEP-6 or - SEP-24 Anchor, the `account` and `memo` - fields should be used. -
    - + + + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. + + For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used. + + + +
    - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    - - @@ -2499,7 +2523,9 @@ Receive a JSON object representing an event. style={{}} className={"openapi-markdown__details"} > - + @@ -2507,140 +2533,133 @@ Receive a JSON object representing an event. className={"openapi-schema__property"} > receiver - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer - in the business' Backend. For a SEP-31 - Sending Anchor, the `account` and `memo` - fields should be used. For a SEP-6 or - SEP-24 Anchor, the `account` and `memo` - fields should be used. -
    - + + + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. + + For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used. + + + +
    - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    - - +
    - - - + + + creator - - - object + + object - -
    +
    - StellarId's are objects that identify end-users - and SEP-31 Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 customer, the - `id` field should be sufficient to fully - identify the customer in the business' Backend. - For a SEP-31 Sending Anchor, the `account` and - `memo` fields should be used. For a SEP-6 or - SEP-24 Anchor, the `account` and `memo` fields - should be used. -
    - + + + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. + + For a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used. + + + +
    - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    @@ -2648,190 +2667,235 @@ Receive a JSON object representing an event. - - -
    - - - + +
    + + + quote - - object + + object + - -
    +
    - + + - + + - + + - + + - + + - + + - + + - + schema={{"type":"string"}} + > + +
    - - - + + + creator - - - object + + object - -
    +
    - StellarId's are objects that identify end-users and - SEP-31 Sending Anchors, but not SEP-31 Receiving - Anchors. For a SEP-12 customer, the `id` field - should be sufficient to fully identify the customer - in the business' Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, the `account` - and `memo` fields should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - - + + + schema={{"type":"string","format":"date-time"}} + > + +
    -
    - -
    - - - + +
    + + + customer - - object + + object + - -
    +
    + schema={{"type":"string"}} + > + +
    @@ -2841,23 +2905,38 @@ Receive a JSON object representing an event. - -
    +
    - - + +
    - The event is successfully processed and ready to receive next event. - The response body is empty. + + + The event is successfully processed and ready to receive next event. The response body is empty. + + +
    +
    -
    -
    - +
    - The event is invalid or rejected. The response body contains the error - message. + + + The event is invalid or rejected. The response body contains the error message. + + +
    +
    -
    diff --git a/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx b/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx index ac8e3ad4c3..b6c0708d15 100644 --- a/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx +++ b/platforms/anchor-platform/api-reference/callbacks/put-customer.api.mdx @@ -5,7 +5,7 @@ description: "**The Anchor Platform does not persist any customer KYC data.**" sidebar_label: "Create or Update Customer Info" hide_title: true hide_table_of_contents: true -api: eJztGl1v47jxrxDsw90uZNmbC1rAb6nXe3Cvl83FSYtDHMiUNIp4K5E6kkpiBPnvxZCS9WHJ2fZaoAv4JZE5w/nizHCG5As17EHT+R1dlNrIHJSm9x59nmgo7PB6eTX5M/Xs/w9n1cfZefXxwwfEjkFHiheGS0Hn9P37mxTIhYhSqchVxkwiVU5iCZoIaUgBSnNtCBM7ElU8yU+/LkjMDPPfv9+IjUACCn4vweLFRIEupNBAEqmISbkmIOJCcmEIU0B4DMLwiGXESGJS2Ii77dXtDZnW9Lf336fGFHo+nT5wk5ahH8l8qg1kGVP1/0mhpJGRzKZhJsNpzrQBNYVI6p02kE81FJPZ7MOZn8d/qglPitK824hBWWNIuICYcEGc8XxUbZFxQLGLIuMRQ5NpkrMve301eeImRS1IIrNMPnHxsLdFKOOdR55SHqWEa7TGE1MxxJXehFmj+5Xx9UbkpTbkkWU8ZgaseLX5ER0tTgqmNcReJbsplbCwWsPvNNnyeOuT61q+SArDuEC5pMh2RBuF3wmHLEbps2wjQhgTjrCWhtuWGaa/aSm2ljoayOwKGGS6ESEXTO3aDMnX8svLzPCCKTNFp5ygAXosN4J6VBagrFCrmM5pUZo6OKhHq7X4q4x3dP5Cq8n42VcGx3SUQs7wC6nTOZXhbxAZ6tFCIRfDQSOUx/i3G0gYBauPRCadBUGF3Do53zI2ViqfkwlhpFDwyGWpCcZAJa5PvVoCt1701aMsimTpZD/kvHZRQaQiP5fPEJMLh01YaVIXbwbixrb7SH/kzDn8bJBpDrkc5ogQdNayjuhkh47FGtUtM0Z0yhTEpBIfAwIUWCG6EIyRbfW9HRUmcKNDEiEEbWolK7XzrVq2NwU75OhREGWOaZXH1KMp0yniwLOh96818jFBWISDXX/gmoSAhvrp10WMYeBvxBqcPe5ucOK6gIgnlWv+t1MhijbRbQ7vSCyjMgdh2tnP5u5cYroWifQ34pNUxO0hZCdLEjFRpUz8qYh8ElZtXTs55imXCRL+ULr4bJE5O0fHn9RZ1/nRVkNxdj7Z7wNoLFxHF+YH7mAUE9rZOBiLyBYO4ZX/u4zcS5uoJvJjWsuIY7D45J8pCAtQuZWfJErm3eWMoQARa+KWeSPa/L4H/8H3GivWVLi2cc7R+dDMGVMPmClydEP9bljZhCttAsFyaKWnBpyxY1AWxxxZs+wojgKtAxsMahdEMh5G1IYZCKQKCiUfuYiGsSJudoOAQmrDsnHylRyDsFyGPINAlHkIahADcsaz4BiNkCuTBrjDHoI96laJzqlF2KMXGRvR08HfNFrIxJdx21tolYeOadfBq/PPCK83qBSpFEctabFChfvyUYM/G1DoWNbzE1BBvWUcukTGwqMso7AMWMbZ0cXPpYDdMSodPOuj8Rg/tSuMPOotFcrwNvgRCgWRyxW3Gsh22BhbwoU2wOLBTc2w5yp7jYDG3UZGUVkwJ8xgLBSZ3IEaJ7DHOGaCjImHkj3AuHPzeNwZefx2cPA44FqX8PVRyeMAngvutpV/a9oRx+HFUTtoeB4cV5CAUiwbW8VO0goeQe233rcz2Fvo6CTcZDh01dS9VR1uwQM19KnSPVW6p0r3W6p0T8Xfqfg7FX+n4u9U/P3Pir8ilUaiwRMlXekxStCdaHYmhSz68pVzhDRM7QJWoHeyLJBJUJP5Sgpv1KmOWqGkTAIFGsuCofQ1SHqsxm3TlEnARSSHvGrYSPWsjD+CGJR6cN7/X139c11LNwX2qxXUVblWsbPZ7DBXrMsoAq0xBfzHJ9D1kRFWabgLl/bqZ6haH9y0y0Gz12XfxWKxvLpZfqQevbr+vFiu16vLH6lHL5fLj+tgdfnpM/Xo9fJvywUi3duSBM/zhwRt6o2rjnBtBeyc7lXUgTLDWaWReT9QuYxHq/D2XMijlJ1lGMrwqeRRmx1lSjGkxQ3kQ/GFmbdw6rWgoZQZMFE5RLXvxMHJSING+iMeuXdCj/5jeb36tFpc3Kw+XwbXy19uV9eVc4JScijN29XJQWv2MLQZtaL+R2h10y68q+nnQwG+Evbazt2K/pEo767umB7ecKS/drOEm33fKLW0A7Ua54dqXEpDPslSxN+CDlX9KTTeytL53Qv9Ajs6r2/DPWpbra+7FX+9R78wqaxuEFELZlI6p/tbaYq7o3rEK3fkVaqMzmndskYsy7AG8MNSc9zjJg7Xh2eWF+j19qo3kjlFVmjD6+ZmcumQ6gzeBMP+IKQZcsVo93dVgLnmvR9Q/VuS1p7b6iqb0VYz2RKk30N2QAOtYwMf6BgboGsUm9+d/vCAR0fvbjfYSiDdJrCdAZvej57Nzs4nH2aT2V9or83rTxjTq9XU9Qb7vdwIuL9Qnc6tN9xt2HrAXp/WMsVIe9ayf6cra403zdiBybs92Ai4ab1aRHsd1wGkL13dHfVHDsze7oXantBpgQYAA6L0Gp4GsO9zOkNj3tHrarr+NtTAHGAcGrhd97fiC0v25menah4Jl171OxI7I1iYuEViG2JMhg72gz/zZ7T/tsge1+5ElCop8Nx3UWVJTS6uVqRzNle9FWqOd/svkgolcXvx6wdH43TdSZtunujkLAYS7rqnwU8pz4BwexZbKInluTvUrV/v2LteRqKDF0A+ucGbXpfSv9P7Q25dPWXRrddBLEkgMl3OffwhFu4YsNryGvXWdlNBL+URYEkyf6GVc18ULEqBnNllaDan+XT69PTkMwv1pXqYVlP19O+rxfJyvZyc+TM/NXlm915MwDkTLcILBfgaSSpyW9h3SXVdRFboBgfl475sOD0tOz0t+9afllUZH29CpkXGuG1ebHS9VAXiHd0XiPceTaU2OPbyEjINtyp7fcXh30tQOzq/u8eiVHEWYlzfYaeSArO75L56XTgZJjeu+atq2MFrvFevnnQRRVCYFvpBwd4pcK9ub7B2qN7E5W7rQrqWrNd8ooyvr/8Co0T/LQ== +api: eJztGl1v47jxrxDsw90uZDnrCwrUb6nXe3Cvl83FSYtDHMiUNIp4K5E6kkpiBPnvxZCS9WHJ2fZaoAv4JZE5w/nizHCG5As17EHT+R1dlNrIHJSm9x59nmgo7PB6eTX5M/Xs/w+z6mN2Xn388AGxY9CR4oXhUtA5ff/+JgVyIaJUKnKVMZNIlZNYgiZCGlKA0lwbwsSORBVP8tOvCxIzw/z37zdiI5CAgt9LsHgxUaALKTSQRCpiUq4JiLiQXBjCFBAegzA8YhkxkpgUNuJue3V7Q6Y1/e3996kxhZ5Ppw/cpGXoRzKfagNZxlT9f1IoaWQks2mYyXCaM21ATSGSeqcN5FMNxeTs7MPMz+M/1YQnRWnebcSgrDEkXEBMuCDOeD6qtsg4oNhFkfGIock0ydmXvb6aPHGTohYkkVkmn7h42NsilPHOI08pj1LCNVrjiakY4kpvwqzR/cr4eiPyUhvyyDIeMwNWvNr8iI4WJwXTGmKvkt2USlhYreF3mmx5vPXJdS1fJIVhXKBcUmQ7oo3C74RDFqP0WbYRIYwJR1hLw23LDNPftBRbSx0NZHYFDDLdiJALpnZthuRr+eVlZnjBlJmiU07QAD2WG0E9KgtQVqhVTOe0KE0dHNSj1Vr8VcY7On+h1WT87CuDYzpKIWf4hdTpnMrwN4gM9WihkIvhoBHKY/zbDSSMgtVHIpPOgqBCbp2cbxkbK5XPyYQwUih45LLUBGOgEtenXi2BWy/66lEWRbJ0sh9yXruoIFKRn8tniMmFwyasNKmLNwNxY9t9pD9y5hz+bJBpDrkc5ogQdNayjuhkh47FGtUtM0Z0yhTEpBIfAwIUWCG6EIyRbfW9HRUmcKNDEiEEbWolK7XzrVq2NwU75OhREGWOaZXH1KMp0yniwLOh96818jFBWISDXX/gmoSAhvrp10WMYeBvxBqcPe5ucOK6gIgnlWv+t1MhijbRbQ7vSCyjMgdh2tnP5u5cYroWifQ34pNUxO0hZCdLEjFRpUz8qYh8ElZtXTs55imXCRL+ULr4bJGZnaPjT+qs6/xoq6GYnU/2+wAaC9fRhfmBOxjFhHY2DsYisoVDeOX/LiP30iaqifyY1jLiGCw++WcKwgJUbuUniZJ5dzljKEDEmrhl3og2v+/Bf/C9xoo1Fa5tnHN0PjRzxtQDZooc3VC/G1Y24UqbQLAcWumpAWfsGJTFMUfWLDuKo0DrwAaD2gWRjIcRtWEGAqmCQslHLqJhrIib3SCgkNqwbJx8JccgLJchzyAQZR6CGsSAnPEsOEYj5MqkAe6wh2CPulWic2oR9uhFxkb0dPA3jRYy8WXc9hZa5aFj2nXw6vwzwusNKkUqxVFLWqxQ4b581ODPBhQ6lvX8BFRQbxmHLpGx8CjLKCwDlnF2dPFzKWB3jEoHz/poPMZP7Qojj3pLhTK8DX6EQkHkcsWtBrIdNsaWcKENsHhwUzPsucpeI6Bxt5FRVBbMCTMYC0Umd6DGCewxjpkgY+KhZA8w7tw8HndGHr8dHDwOuNYlfH1U8jiA54K7beXfmnbEcXhx1A4angfHFSSgFMvGVrGTtIJHUPut9+0M9hY6Ogk3GQ5dNXVvVYdb8EANfap0T5XuqdL9lirdU/F3Kv5Oxd+p+DsVf/+z4q9IpZFo8ERJV3qMEnQnmp1JIYu+fOUcIQ1Tu4AV6J0sC2QS1GS+ksIbdaqjVigpk0CBxrJgKH0Nkh6rcds0ZRJwEckhrxo2Uj0r448gBqUenPf/V1f/XNfSTYH9agV1Va5VbHZ2dpgr1mUUgdaYAv7jE+j6yAirNNyFS3v1M1StD27a5aDZ67LvYrFYXt0sP1KPXl1/XizX69Xlj9Sjl8vlx3Wwuvz0mXr0evm35QKR7m1Jguf5Q4I29cZVR7i2AnZO9yrqQJnhrNLIvB+oXMajVXh7LuRRys4yDGX4VPKozY4ypRjS4gbyofjCzFs49VrQUMoMmKgcotp34uBkpEEj/RGP3DuhR/+xvF59Wi0ublafL4Pr5S+3q+vKOUEpOZTm7erkoDV7GNqMWlH/I7S6aRfe1fTzoQBfCXtt525F/0iUd1d3TA9vONJfu1nCzb5vlFragVqN80M1LqUhn2Qp4m9Bh6r+FBpvZen87oV+gR2d17fhHrWt1tfdir/eo1+YVFY3iKgFMymd0/2tNMXdUT3ilTvyKlVG57RuWSOWZVgD+GGpOe5xE4frwzPLC/R6e9UbyZwiK7ThdXMzuXRIdQZvgmF/ENIMuWK0+7sqwFzz3g+o/i1Ja89tdZXNaKuZbAnS7yE7oIHWsYEPdIwN0DWKze9Of3jAo6N3txtsJZBuE9jOgE3vR2dns/PJh7PJ7C+01+b1J4zp1WrqeoP9Xm4E3F+oTufWG+42bD1gr09rmWKkPWvZv9OVtcabZuzA5N0ebATctF4tor2O6wDSl67ujvojB2Zv90JtT+i0QAOAAVF6DU8D2Pc5naEx7+h1NV1/G2pgDjAODdyu+1vxhSV787NTNY+ES6/6HYmdESxM3CKxDTEmQwf7wT/zz2j/bZE9rt2JKFVS4LnvosqSmlxcrUjnbK56K9Qc7/ZfJBVK4vbi1w+Oxum6kzbdPNHJWQwk3HVPg59SngHh9iy2UBLLc3eoW7/esXe9jEQHL4B8coM3vS6lf6f3h9y6esqiW6+DWJJAZLqc+/hDLNwxYLXlNeqt7aaCXsojwJJk/kIr574oWJQCmdllaDan+XT69PTkMwv1pXqYVlP19O+rxfJyvZzM/DM/NXlm915MwDkTLcILBfgaSSpyW9h3SXVdRFboBgfl475sOD0tOz0t+9afllUZH29CpkXGuG1ebHS9VAXiHd0XiPceTaU2OPbyEjINtyp7fcXh30tQOzq/u8eiVHEWYlzfYaeSArO75L56XTgZJjeu+atq2MFrvFevnnQRRVCYFvpBwd4pcK9ub7B2qN7E5W7rQrqWrNd8ooyvr/8C/Ob/OQ== sidebar_class_name: "put api-method" info_path: platforms/anchor-platform/api-reference/callbacks/callbacks-server custom_edit_url: null @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,929 +34,1042 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Create or Update Customer Info"} -> +> + + + + + + - **The Anchor Platform does not persist any customer KYC data.** -The request and response for this endpoint are identical to the [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request and response defined in SEP-12. +The request and response for this endpoint are identical to the +[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) +request and response defined in SEP-12. + +Client applications make requests with the following request body, which is forwarded to the anchor. Anchors +must validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will +be forwarded to the anchor as with the `application/json` content type. Requests containing +binary fields will be forwarded to the anchor as with the `multipart/form-data` content type. -Client applications make requests with the following request body, which is forwarded to the anchor. Anchors must validate and persist the data passed, and return the customer's `id`. Requests containing only string fields will be forwarded to the anchor as with the `application/json` content type. Requests containing binary fields will be forwarded to the anchor as with the `multipart/form-data` content type. +> + - - + +
    - -

    + +

    Body

    -
    -
    -
      +

    + +
      - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + schema={{"type":"string"}} + > + +
    -
    - +
    - -

    + +

    Body

    -
    -
    -
      +

    + +
      - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + schema={{"type":"string"}} + > + +
    -
    -
    +
    - - -
    Success.
    + +
    - - - - + + + Success. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + - + qualifierMessage={"**Possible values:** [`ACCEPTED`, `PROCESSING`, `NEEDS_INFO`, `REJECTED`]"} + schema={{"type":"string","enum":["ACCEPTED","PROCESSING","NEEDS_INFO","REJECTED"]}} + > + +
        - - - + + + fields - - - object + + object - -
        +
        - - + + property name* - - + > + + - -
        +
        - + + - + + - + + + schema={{"type":"boolean"}} + > + +
    - - +
    - - - + + + provided_fields - - - object + + object - -
    +
    - - + + property name* - - + > + + - -
    +
    - + + - + + - + + - + + - + + + schema={{"type":"string"}} + > + +
    - - + schema={{"type":"string"}} + > + + - - + > + +
    - - -
    Invalid data.
    +
    - - - - + + + Invalid data. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Not Found.
    +
    - - - - + + + Not Found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/api-reference/custody/create-custody-transaction.api.mdx b/platforms/anchor-platform/api-reference/custody/create-custody-transaction.api.mdx index 9b03be5755..0df32a8abe 100644 --- a/platforms/anchor-platform/api-reference/custody/create-custody-transaction.api.mdx +++ b/platforms/anchor-platform/api-reference/custody/create-custody-transaction.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,9 +34,17 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Create Custody Transaction"} -> +> + + + + + + - Custody Server creates custody transaction record in DB. @@ -45,145 +53,164 @@ Custody Server creates custody transaction record in DB. as={"h2"} className={"openapi-tabs__heading"} children={"Request"} -> +> + - - + +
    - -

    + +

    Body

    -
    -
    -
      +

    + +
      - + + - + + - + + - + + - + + - + + - + + - + + - + + + qualifierMessage={"**Possible values:** [`deposit`, `withdrawal`, `receive`]"} + schema={{"description":"Kind of the SEP transaction.","type":"string","enum":["deposit","withdrawal","receive"]}} + > + +
    -
    -
    +
    - - -
    Success.
    + +
    - - - - + + + Success. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + + object + +
    -
    - + > + +
    -
    - -
    Internal Server Error
    +
    - - - - + + + Internal Server Error + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/api-reference/custody/generate-unique-address.api.mdx b/platforms/anchor-platform/api-reference/custody/generate-unique-address.api.mdx index 1119bd8a6e..50bdc3fa52 100644 --- a/platforms/anchor-platform/api-reference/custody/generate-unique-address.api.mdx +++ b/platforms/anchor-platform/api-reference/custody/generate-unique-address.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,54 +34,104 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Generate Unique Address"} -> +> + +> + + + + Custody Server calls the configured custody service to generate deposit address and memo. Format of `asset` parameter - `stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5` + +> + - - + +
    - -

    + +

    Body

    -
    -
    -
      -
      object
      +

    + +
      +
      + + + object + + +
    -
    -
    +
    - - -
    Success.
    + +
    - - - - + + + Success. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + - + + + qualifierMessage={"**Possible values:** [`id`, `hash`, `text`]"} + schema={{"description":"Type of memo, that should be added to payment by the client.","type":"string","enum":["id","hash","text"]}} + > + +
    -
    - + > + +
    -
    - -
    Internal Server Error.
    +
    - - - - + + + Internal Server Error. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/api-reference/custody/send-payment.api.mdx b/platforms/anchor-platform/api-reference/custody/send-payment.api.mdx index 35c005a45e..2e762a40d5 100644 --- a/platforms/anchor-platform/api-reference/custody/send-payment.api.mdx +++ b/platforms/anchor-platform/api-reference/custody/send-payment.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,12 +34,17 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Send Payment"} -> +> + +> + + + + Custody Server calls the configured custody service to send payment. @@ -48,38 +53,82 @@ Custody Server calls the configured custody service to send payment. as={"h2"} className={"openapi-tabs__heading"} children={"Request"} -> +> + - - + +
    - -

    + +

    Body

    -
    -
    -
      -
      object
      +

    + +
      +
      + + + object + + +
    -
    -
    +
    - - -
    Success.
    + +
    - - - - + + + Success. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string","description":"External TX ID from custody service."}} + > + +
    -
    - + > + +
    -
    - -
    Invalid Request.
    +
    - - - - + + + Invalid Request. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Custody Transaction is not found.
    +
    - - - - + + + Custody Transaction is not found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Custody Service rate limit is exceeded.
    +
    - - - - + + + Custody Service rate limit is exceeded. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Internal Server Error.
    +
    - - - - + + + Internal Server Error. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Custody Service is unavailable.
    +
    - - - - + + + Custody Service is unavailable. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/api-reference/custody/send-refund.api.mdx b/platforms/anchor-platform/api-reference/custody/send-refund.api.mdx index 8e8e80f876..0ca31da907 100644 --- a/platforms/anchor-platform/api-reference/custody/send-refund.api.mdx +++ b/platforms/anchor-platform/api-reference/custody/send-refund.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,12 +34,17 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Send Refund"} -> +> + +> + + + + Custody Server calls configured Custody Service to send refund. Custody transaction record is also created in DB. @@ -48,80 +53,110 @@ Custody Server calls configured Custody Service to send refund. Custody transact as={"h2"} className={"openapi-tabs__heading"} children={"Request"} -> +> + - - + +
    - -

    + +

    Body

    -
    -
    -
      +

    + +
      - + + - + + - + + + schema={{"description":"Fee of the refund.","type":"string"}} + > + +
    -
    -
    +
    - - -
    Success.
    + +
    - - - - + + + Success. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string","description":"External TX ID from custody service."}} + > + +
    -
    - + > + +
    -
    - -
    Invalid Request.
    +
    - - - - + + + Invalid Request. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Custody Transaction is not found.
    +
    - - - - + + + Custody Transaction is not found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Custody Service rate limit is exceeded.
    +
    - - - - + + + Custody Service rate limit is exceeded. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Internal Server Error.
    +
    - - - - + + + Internal Server Error. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Custody Service is unavailable.
    +
    - - - - + + + Custody Service is unavailable. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/api-reference/platform/transactions/get-transaction.api.mdx b/platforms/anchor-platform/api-reference/platform/transactions/get-transaction.api.mdx index 5caceec5ac..66953fcfde 100644 --- a/platforms/anchor-platform/api-reference/platform/transactions/get-transaction.api.mdx +++ b/platforms/anchor-platform/api-reference/platform/transactions/get-transaction.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,9 +34,17 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Retrieve a Transaction"} -> +> + + + + + + - Provides the information necessary for the business to determine the state of the transaction identified by `id`, decide if any action must be taken to continue processing the transaction, and act on the decision. @@ -45,43 +53,65 @@ Provides the information necessary for the business to determine the state of th as={"h2"} className={"openapi-tabs__heading"} children={"Request"} -> +> +
    - -

    + +

    Path Parameters

    -
    -
    +

      + param={{"in":"path","name":"id","required":true,"schema":{"type":"string"}}} + > + +
    -
    -
    +
    - - -
    Transaction found.
    + +
    - - - - + + + Transaction found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - oneOf - + + oneOf + - + + - + + - + + - + + - + + @@ -192,39 +195,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_expected - - - object + + object - -
        +
        - + + + schema={{"type":"string"}} + > + +
    - - @@ -232,39 +243,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_in - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -272,39 +291,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_out - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -312,36 +339,44 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + fee_details - - - object + + object - -
    +
    - + + - + + @@ -349,72 +384,61 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + details - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -424,64 +448,70 @@ Provides the information necessary for the business to determine the state of th
  • -
    - - + + - + + - + + - + + - + + - + + - + + @@ -489,19 +519,25 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + refunds - - - object + + object - -
    +
    - + amount_refunded - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -558,47 +594,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + amount_fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -606,195 +642,166 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + payments - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + +
    - + amount - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -804,8 +811,7 @@ Provides the information necessary for the business to determine the state of th
  • -
    - @@ -813,96 +819,77 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + stellar_transactions - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -910,290 +897,231 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + payments - - - object[] - - - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + +
    - + amount - - - object - - - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • -
    -
  • +
  • ]
  • -
    - - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -1201,29 +1129,35 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + customers - - - object + + object - -
    +
    - The user that initiated the transaction is - both the sender and receiver. -
    - @@ -1231,85 +1165,71 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + sender - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -1317,88 +1237,74 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + receiver - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -1406,77 +1312,72 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + creator - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer in - the business' Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` fields - should be used. For a SEP-6 or SEP-24 - Anchor, the `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    - - @@ -1486,74 +1387,46 @@ Provides the information necessary for the business to determine the state of th required={true} schemaName={"string"} qualifierMessage={undefined} - schema={{ type: "string" }} - >
    - + + - + + - + + - + + - + + @@ -1561,47 +1434,55 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_expected - - - object - - + object + - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1609,39 +1490,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_in - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1649,39 +1538,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_out - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1689,36 +1586,44 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + fee_details - - - object + + object - -
    +
    - + + - + + @@ -1726,72 +1631,61 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + details - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -1801,64 +1695,70 @@ Provides the information necessary for the business to determine the state of th
  • -
    - - + + - + + - + + - + + - + + - + + - + + @@ -1866,19 +1766,25 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + refunds - - - object + + object - -
    +
    - + amount_refunded - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1935,47 +1841,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + amount_fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1983,195 +1889,166 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + payments - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + +
    - + amount - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -2181,8 +2058,7 @@ Provides the information necessary for the business to determine the state of th
  • -
    - @@ -2190,96 +2066,77 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + stellar_transactions - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -2287,290 +2144,231 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + payments - - - object[] - - - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + +
    - + amount - - - object - - - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • -
    -
  • +
  • ]
  • -
    - - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -2578,29 +2376,35 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + customers - - - object + + object - -
    +
    - The user that initiated the transaction is - both the sender and receiver. -
    - @@ -2608,85 +2412,71 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + sender - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -2694,88 +2484,74 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + receiver - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -2783,77 +2559,72 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + creator - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer in - the business' Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` fields - should be used. For a SEP-6 or SEP-24 - Anchor, the `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    - - @@ -2863,67 +2634,46 @@ Provides the information necessary for the business to determine the state of th required={true} schemaName={"string"} qualifierMessage={undefined} - schema={{ type: "string" }} - >
    - + + - + + - + + - + + - + + @@ -2931,39 +2681,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_expected - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -2971,39 +2729,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_in - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3011,39 +2777,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + amount_out - - - object + + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3051,36 +2825,44 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + fee_details - - - object + + object - -
    +
    - + + - + + @@ -3088,72 +2870,61 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + details - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -3163,64 +2934,70 @@ Provides the information necessary for the business to determine the state of th
  • -
    - - + + - + + - + + - + + - + + - + + - + + @@ -3228,19 +3005,25 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + refunds - - - object + + object - -
    +
    - + amount_refunded - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3297,47 +3080,47 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + amount_fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3345,195 +3128,166 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + payments - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + +
    - + amount - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -3543,8 +3297,7 @@ Provides the information necessary for the business to determine the state of th
  • -
    - @@ -3552,96 +3305,77 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + stellar_transactions - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -3649,290 +3383,231 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + payments - - - object[] - - - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + +
    - + amount - - - object - - - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • -
    -
  • +
  • ]
  • -
    - - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -3940,34 +3615,36 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + customers - - - object + + object - -
    +
    - The Identification info of the sending and - receiving customers. If they were created - through - [SEP-12](https://stellar.org/protocol/sep-12), - this object should contain the SEP-12 - customer `id`. Otherwise, the `account` - address of the customer. -
    - @@ -3975,85 +3652,71 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + sender - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -4061,88 +3724,74 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - + receiver - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -4150,72 +3799,68 @@ Provides the information necessary for the business to determine the state of th style={{}} className={"openapi-markdown__details"} > - - + + creator - - - object + + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, but - not SEP-31 Receiving Anchors. For a SEP-12 - customer, the `id` field should be - sufficient to fully identify the customer in - the business' Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` fields - should be used. For a SEP-6 or SEP-24 - Anchor, the `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    @@ -4224,28 +3869,47 @@ Provides the information necessary for the business to determine the state of th
    - - + > + +
    - - -
    Bad Request
    +
    - - - - + + + Bad Request + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Transaction not found.
    +
    - - - - + + + Transaction not found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/api-reference/platform/transactions/get-transactions.api.mdx b/platforms/anchor-platform/api-reference/platform/transactions/get-transactions.api.mdx index 09edfb3b91..69389c61b6 100644 --- a/platforms/anchor-platform/api-reference/platform/transactions/get-transactions.api.mdx +++ b/platforms/anchor-platform/api-reference/platform/transactions/get-transactions.api.mdx @@ -14,7 +14,7 @@ hide_send_button: true import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -34,9 +34,17 @@ import TabItem from "@theme/TabItem"; as={"h1"} className={"openapi__heading"} children={"Retrieve a List of Transactions"} -> +> + + + + + + - Allows to query list of transactions for desired SEP. This api supports pagination, and it's possible (and recommended) to make multiple requests to query transactions. The last page is reached when the number of elements returned by the endpoint is smaller than provided `page_size`. @@ -45,129 +53,90 @@ Allows to query list of transactions for desired SEP. This api supports paginati as={"h2"} className={"openapi-tabs__heading"} children={"Request"} -> +> +
    - -

    + +

    Query Parameters

    -
    -
    +

      - + + - + + - + + - + + - + + + param={{"in":"query","name":"page_number","schema":{"type":"integer","default":0},"description":"Page number to use for continuous search. Page count beings at 0."}} + > + +
    -
    -
    +
    - - -
    Transaction found.
    + +
    - - - - + + + Transaction found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - oneOf - + + oneOf + - - + + records - - - object[] + + object[] - -
        +
      • Array [
        -
      • - - + + - + + - + + - + + - + + @@ -313,47 +253,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_expected - - - object + object - -
        +
        - + + + schema={{"type":"string"}} + > + +
    - - @@ -361,47 +301,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_in - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -409,47 +349,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_out - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -457,121 +397,106 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + fee_details - - - object + object - -
    +
    - + + - + +
    - + details - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -581,79 +506,70 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • -
    - - + + - + + - + + - + + - + + - + + - + + @@ -661,356 +577,289 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + refunds - - - object + object - -
    +
    - + amount_refunded - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + amount_fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + payments - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + +
    - + amount - - - object + object - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    -
    - + fee - - - object + object - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -1020,8 +869,7 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • -
    - @@ -1029,416 +877,309 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + stellar_transactions - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + +
    - + payments - - - object[] - - - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + +
    - + amount - - - object - - - + + required - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • -
    -
  • +
  • ]
  • -
    - - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -1446,225 +1187,182 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + customers - - - object + object - -
    +
    - The user that initiated the - transaction is both the sender and - receiver. -
    -
    - + sender - - - object + object - -
    +
    - StellarId's are objects that - identify end-users and SEP-31 - Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 - customer, the `id` field should - be sufficient to fully identify - the customer in the business' - Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` - fields should be used. For a - SEP-6 or SEP-24 Anchor, the - `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    -
    - + receiver - - - object + object - -
    +
    - StellarId's are objects that - identify end-users and SEP-31 - Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 - customer, the `id` field should - be sufficient to fully identify - the customer in the business' - Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` - fields should be used. For a - SEP-6 or SEP-24 Anchor, the - `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -1672,91 +1370,73 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + creator - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    -
  • +
  • ]
    @@ -1764,8 +1444,7 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • - - @@ -1777,107 +1456,77 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - - + + records - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -1885,59 +1534,55 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_expected - - - object - - - + + required - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1945,47 +1590,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_in - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -1993,47 +1638,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_out - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -2041,121 +1686,106 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + fee_details - - - object + object - -
    +
    - + + - + +
    - + details - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -2165,79 +1795,70 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • -
    - - + + - + + - + + - + + - + + - + + - + + @@ -2245,356 +1866,289 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + refunds - - - object + object - -
    +
    - + amount_refunded - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + amount_fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + payments - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + +
    - + amount - - - object + object - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    -
    - + fee - - - object + object - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -2604,8 +2158,7 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • -
    - @@ -2613,416 +2166,309 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + stellar_transactions - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + +
    - + payments - - - object[] - - - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + +
    - + amount - - - object - - - + + required - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • -
    -
  • +
  • ]
  • -
    - - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -3030,225 +2476,182 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + customers - - - object + object - -
    +
    - The user that initiated the - transaction is both the sender and - receiver. -
    -
    - + sender - - - object + object - -
    +
    - StellarId's are objects that - identify end-users and SEP-31 - Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 - customer, the `id` field should - be sufficient to fully identify - the customer in the business' - Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` - fields should be used. For a - SEP-6 or SEP-24 Anchor, the - `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    -
    - + receiver - - - object + object - -
    +
    - StellarId's are objects that - identify end-users and SEP-31 - Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 - customer, the `id` field should - be sufficient to fully identify - the customer in the business' - Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` - fields should be used. For a - SEP-6 or SEP-24 Anchor, the - `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -3256,91 +2659,73 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + creator - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    -
  • +
  • ]
    @@ -3348,8 +2733,7 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • - - @@ -3361,103 +2745,77 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - - + + records - - - object[] + + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + + @@ -3465,47 +2823,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_expected - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3513,47 +2871,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_in - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3561,47 +2919,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + amount_out - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    - @@ -3609,121 +2967,106 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + fee_details - - - object + object - -
    +
    - + + - + +
    - + details - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + -
  • + schema={{"type":"string"}} + > + +
  • ]
    @@ -3733,79 +3076,70 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • -
    - - + + - + + - + + - + + - + + - + + - + + @@ -3813,356 +3147,289 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + refunds - - - object + object - -
    +
    - + amount_refunded - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + amount_fee - - - object + object - -
    +
    - + + + schema={{"type":"string"}} + > + +
    -
    -
    - + payments - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + +
    - + amount - - - object + object - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    -
    - + fee - - - object + object - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    - - + + -
  • + schema={{"type":"string","format":"date-time"}} + > + +
  • ]
    @@ -4172,8 +3439,7 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • -
    - @@ -4181,416 +3447,309 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + stellar_transactions - - - object[] + object[] - -
    +
  • Array [
    -
  • - - + + - + + - + + - + + - + +
    - + payments - - - object[] - - - + + required - -
    +
  • Array [
    -
  • - - + + - + + - + + - + +
    - + amount - - - object - - - + + required - -
    - + + + qualifierMessage={undefined} + schema={{"type":"string"}} + > + +
    -
    -
  • +
  • ]
  • -
    -
  • +
  • ]
  • -
    - - + + - + + - + + - + + - + + - + + - + + - + + - + + @@ -4598,229 +3757,183 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + customers - - - object + object - -
    +
    - The Identification info of the sending - and receiving customers. If they were - created through - [SEP-12](https://stellar.org/protocol/sep-12), - this object should contain the SEP-12 - customer `id`. Otherwise, the - `account` address of the customer. -
    -
    - + sender - - - object + object - -
    +
    - StellarId's are objects that - identify end-users and SEP-31 - Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 - customer, the `id` field should - be sufficient to fully identify - the customer in the business' - Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` - fields should be used. For a - SEP-6 or SEP-24 Anchor, the - `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    -
    - + receiver - - - object + object - -
    +
    - StellarId's are objects that - identify end-users and SEP-31 - Sending Anchors, but not SEP-31 - Receiving Anchors. For a SEP-12 - customer, the `id` field should - be sufficient to fully identify - the customer in the business' - Backend. For a SEP-31 Sending - Anchor, the `account` and `memo` - fields should be used. For a - SEP-6 or SEP-24 Anchor, the - `account` and `memo` fields - should be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    - @@ -4828,91 +3941,73 @@ Allows to query list of transactions for desired SEP. This api supports paginati style={{}} className={"openapi-markdown__details"} > - + creator - - - object + object - -
    +
    - StellarId's are objects that identify - end-users and SEP-31 Sending Anchors, - but not SEP-31 Receiving Anchors. For - a SEP-12 customer, the `id` field - should be sufficient to fully identify - the customer in the business' Backend. - For a SEP-31 Sending Anchor, the - `account` and `memo` fields should be - used. For a SEP-6 or SEP-24 Anchor, - the `account` and `memo` fields should - be used. -
    - - + + - + + + schema={{"type":"string","description":"The memo value identifying a customer with a shared account, where the shared account is `account`."}} + > + +
    -
    -
  • +
  • ]
    @@ -4925,28 +4020,47 @@ Allows to query list of transactions for desired SEP. This api supports paginati
  • - - + > + +
    - - -
    Bad Request
    +
    - - - - + + + Bad Request + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + + schema={{"type":"string"}} + > + +
    -
    - + > + +
    -
    - -
    Transaction not found.
    +
    - - - - + + + Transaction not found. + + +
    + + + +
    - Schema - -
    -
      + + Schema + +
      + +
        - + + + schema={{"type":"string"}} + > + +
    -
    - + > + +
    diff --git a/platforms/anchor-platform/assets/sep31-transition-diagram.png b/platforms/anchor-platform/assets/sep31-transition-diagram.png index 8dae3cd7b0..a04c0a28ea 100644 Binary files a/platforms/anchor-platform/assets/sep31-transition-diagram.png and b/platforms/anchor-platform/assets/sep31-transition-diagram.png differ diff --git a/static/definitions/sep6_24_31_status_transition_diagrams.drawio b/static/definitions/sep6_24_31_status_transition_diagrams.drawio index 376b876492..056f63dfe7 100644 --- a/static/definitions/sep6_24_31_status_transition_diagrams.drawio +++ b/static/definitions/sep6_24_31_status_transition_diagrams.drawio @@ -1,258 +1,258 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -261,42 +261,42 @@ - + - + - + - + - + - + - + - + - + - + @@ -305,7 +305,7 @@ - + @@ -314,12 +314,12 @@ - + - + @@ -329,31 +329,31 @@ - + - + - + - + - + - + - + @@ -653,15 +653,15 @@ - + - + - + @@ -683,10 +683,10 @@ - - + + - + @@ -696,17 +696,17 @@ - + - + - - + + - + @@ -717,8 +717,8 @@ - - + + @@ -728,8 +728,8 @@ - - + + @@ -738,15 +738,15 @@ - + - + - - + + @@ -755,40 +755,40 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -797,10 +797,10 @@ - + - + @@ -811,10 +811,10 @@ - + - + @@ -841,10 +841,28 @@ - + - + + + + + + + + + + + + + + + + + + +