Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PARTNER-329] SEP-6/24: Add new user_action_required_by transaction field #1484

Merged
merged 4 commits into from
May 8, 2024
Merged

[PARTNER-329] SEP-6/24: Add new user_action_required_by transaction field #1484

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
688993b
[SEP-6/24] Add new action_required_by transaction field
Ifropc May 8, 2024
e084a3f
Add PR number
Ifropc May 8, 2024
72a5e7b
Update wording
Ifropc May 8, 2024
abe416f
Rename field
Ifropc May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions ecosystem/sep-0006.md
View file
Open in desktop
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. |
| `action_required_by` | UTC ISO 8601 string | (optional) The date and time by when the user action is required. This field must be omitted if no user action is required in the current status. Anchor should automatically move transaction into the next status (such as `expired`) once the deadline has been reached. |
Ifropc marked this conversation as resolved.
Show resolved Hide resolved
| `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
Ifropc marked this conversation as resolved.
Show resolved Hide resolved
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 `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
7 changes: 5 additions & 2 deletions ecosystem/sep-0024.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Title: Hosted Deposit and Withdrawal
Author: SDF
Status: Active
Created: 2019-09-18
Updated: 2024-04-22
Version 3.6.0
Updated: 2024-05-07
Version 3.7.0
```

## Simple Summary
Expand Down Expand Up @@ -1086,6 +1086,7 @@ Each object in the `transactions` array should have the following fields:
| `started_at` | UTC ISO 8601 string | Start date and time of transaction. |
| `completed_at` | UTC ISO 8601 string | (optional) The date and time of transaction reaching `completed` or `refunded` status. |
| `updated_at` | UTC ISO 8601 string | (optional) The date and time of transaction reaching the current status. |
| `action_required_by` | UTC ISO 8601 string | (optional) The date and time by when the user action is required. This field must be omitted if no user action is required in the current status. Anchor should automatically move transaction into the next status (such as `expired`) once the deadline has been reached. |
| `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. |
Expand Down Expand Up @@ -1408,6 +1409,8 @@ There is a small set of changes when upgrading from SEP-6 to SEP-24.

## Changelog

- `v3.7.0` Add `action_required_by` field to transaction responses
([#1484](https://github.com/stellar/stellar-protocol/pull/1484/))
- `v3.6.0` Add new `on_hold` status ([#1479](https://github.com/stellar/stellar-protocol/pull/1479/))
- `v3.5.0` Add `fee_details` field to the transaction object
[#1429](https://github.com/stellar/stellar-protocol/pull/1429)
Expand Down
Loading