diff --git a/ecosystem/sep-0024.md b/ecosystem/sep-0024.md index 6174d8686..45c708323 100644 --- a/ecosystem/sep-0024.md +++ b/ecosystem/sep-0024.md @@ -6,8 +6,8 @@ Title: Hosted Deposit and Withdrawal Author: SDF Status: Active Created: 2019-09-18 -Updated: 2022-05-05 -Version 2.3.0 +Updated: 2022-05-06 +Version 2.4.0 ``` ## Simple Summary @@ -690,11 +690,11 @@ Name | Type | Description `amount_fee` | string | Amount of fee charged by anchor. `amount_fee_asset` | string | (optional) The asset in which fees are calculated in. Must be present if the deposit/withdraw was made using non-equivalent assets. The value must be in [SEP-38 Asset Identification Format](sep-0038.md#asset-identification-format). See the [Asset Exchanges](#asset-exchanges) section for more information. `started_at` | UTC ISO 8601 string | Start date and time of transaction. -`completed_at` | UTC ISO 8601 string | (optional) Completion date and time of transaction. +`completed_at` | UTC ISO 8601 string | (optional) The date and time of transaction reaching `completed` or `refunded` status. `stellar_transaction_id` | string | transaction_id on Stellar network of the transfer that either completed the deposit or started the withdrawal. `external_transaction_id` | string | (optional) ID of transaction on external network that either started the deposit or completed the withdrawal. `message` | string | (optional) Human readable explanation of transaction status, if needed. -`refunded` | boolean | (**deprecated**, optional) This field is deprecated in favor of the `refunds` object. True if the transaction was refunded in full. False if the transaction was partially refunded or not refunded. For more details about any refunds, see the `refunds` object. +`refunded` | boolean | (**deprecated**, optional) This field is deprecated in favor of the `refunds` object and the `refunded` status. True if the transaction was refunded in full. False if the transaction was partially refunded or not refunded. For more details about any refunds, see the `refunds` object. `refunds` | object | (optional) An object describing any on or off-chain refund associated with this transaction. The schema for this object is defined in the [Refunds Object Schema](#refunds-object-schema) section below. @@ -729,6 +729,7 @@ Name | Type | Description * `pending_trust` -- the user must add a trustline for the asset for the deposit to complete. * `pending_user` -- the user must take additional action before the deposit / withdrawal can complete, for example an email or 2fa confirmation of a withdraw. * `completed` -- deposit/withdrawal fully completed. +* `refunded` -- the deposit/withdrawal is fully refunded. * `no_market` -- could not complete deposit because no satisfactory asset/XLM market was available to create the account. * `too_small` -- deposit/withdrawal size less than `min_amount`. * `too_large` -- deposit/withdrawal size exceeded `max_amount`. @@ -937,6 +938,7 @@ There is a small set of changes when upgrading from SEP-6 to SEP-24. * Solar wallet: https://solarwallet.io ## Changelog +* `v2.4.0`: Add `refunded` transaction status. ([#1195](https://github.com/stellar/stellar-protocol/pull/1195)) * `v2.3.0`: Change `lang` format from [ISO639-1] to [RFC4646] which is a superset of [ISO639-1]. Add `lang` field to GET `/transactions` and `/transaction`. ([#1191](https://github.com/stellar/stellar-protocol/pull/1191)) * `v2.2.1`: Make `completed_at` field optional. ([#1185](https://github.com/stellar/stellar-protocol/pull/1185)) * `v2.2.0`: Deprecate refunded boolean. Add refund object to transaction records. ([#1128](https://github.com/stellar/stellar-protocol/pull/1128))