diff options
Diffstat (limited to 'site/content/transaction_docs.md')
| -rw-r--r-- | site/content/transaction_docs.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/site/content/transaction_docs.md b/site/content/transaction_docs.md new file mode 100644 index 0000000..820c35f --- /dev/null +++ b/site/content/transaction_docs.md | |||
| @@ -0,0 +1,26 @@ | |||
| 1 | +++ | ||
| 2 | title = "Transactions" | ||
| 3 | description = "Transaction documentation" | ||
| 4 | weight = 6 | ||
| 5 | +++ | ||
| 6 | |||
| 7 | A transaction request between `source` and `target` to move `amount` Gradecoin. | ||
| 8 | |||
| 9 | # Requests | ||
| 10 | |||
| 11 | ## GET | ||
| 12 | A HTTP `GET` request to [/transaction](/transaction) endpoint will return the current list of pending transactions. | ||
| 13 | |||
| 14 | ## POST | ||
| 15 | |||
| 16 | A HTTP `POST` request with Authorization using JWT to [/transaction](/transactions) will allow you to propose your own transactions. | ||
| 17 | |||
| 18 | |||
| 19 | # Fields | ||
| 20 | ``` | ||
| 21 | by: Fingerprint | ||
| 22 | source: Fingerprint | ||
| 23 | target: Fingerprint | ||
| 24 | amount: unsigned 16 bit integer | ||
| 25 | timestamp: ISO 8601 <date>T<time> | ||
| 26 | ``` | ||
