Skip to content

Commit

Permalink
[PARTNER-329] SEP-6/24: Add new user_action_required_by transaction…
Browse files Browse the repository at this point in the history 
… field (#1484)

* [SEP-6/24] Add new action_required_by transaction field

* Add PR number

* Update wording

* Rename field
  • Loading branch information
@Ifropc
Ifropc authored May 8, 2024
1 parent 40d4caf commit ade0bf7
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 28 deletions.
10 changes: 8 additions & 2 deletions ecosystem/sep-0006.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Title: Deposit and Withdrawal API
Author: SDF
Status: Active (Interactive components are deprecated in favor of SEP-24)
Created: 2017-10-30
Updated: 2024-02-21
Version 4.0.0
Updated: 2024-05-07
Version 4.1.0
```

## Simple Summary
Expand Down Expand Up @@ -1426,6 +1426,7 @@ Each object in the `transactions` array should have the following fields:
| `started_at` | UTC ISO 8601 string | (optional) Start date and time of transaction. |
| `updated_at` | UTC ISO 8601 string | (optional) The date and time of transaction reaching the current status. |
| `completed_at` | UTC ISO 8601 string | (optional) Completion date and time of transaction. |
| `user_action_required_by` | UTC ISO 8601 string | (optional) The date and time by when the user action is required. In certain statuses, such as `pending_user_transfer_start` or `incomplete`, anchor waits for the user action and `user_action_required_by` field should be used to show the time anchors gives for the user to make an action before transaction will automatically be moved into a different status (such as `expired` or to be `refunded`). `user_action_required_by` should only be specified for statuses where user action is required, and omitted for all other. Anchor should specify the action waited on using message or `more_info_url`. |
| `stellar_transaction_id` | string | (optional) 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. |
Expand All @@ -1443,6 +1444,9 @@ Each object in the `transactions` array should have the following fields:
status when waiting on Bitcoin or other external crypto network to complete a transaction, or when waiting on a bank
transfer.
- `pending_anchor` -- deposit/withdrawal is being processed internally by anchor.
- `on_hold` -- deposit/withdrawal is currently on hold for additional checks after receiving user's funds. Anchor may
use this status to indicate to the user that transaction is being reviewed (for example, for compliance reasons). Once
this status cleared, transaction should follow the regular flow.
- `pending_stellar` -- deposit/withdrawal operation has been submitted to Stellar network, but is not yet confirmed.
- `pending_trust` -- the user must add a trust-line for the asset for the deposit to complete.
- `pending_user` -- the user must take additional action before the deposit / withdrawal can complete.
Expand Down Expand Up @@ -1785,6 +1789,8 @@ object containing an error message.

## Changelog

- `v4.1.0` Add `user_action_required_by` field to transaction responses and add new `on_hold` status
([#1484](https://github.com/stellar/stellar-protocol/pull/1484/))
- `v4.0.0`: Update flow to delegate getting KYC fields to SEP-12
([#1432](https://github.com/stellar/stellar-protocol/pull/1431))
- `v3.26.0`: Add `location_id` to deposit/withdrawal requests
Expand Down
Loading

0 comments on commit ade0bf7

Please sign in to comment.