Created URI Formatting (markdown)

Athan Clark 2016-09-26 00:51:21 -07:00
parent ec81f02213
commit 458911de68
1 changed files with 23 additions and 0 deletions

23
URI-Formatting.md Normal file

@ -0,0 +1,23 @@
URIs are useful for easy payment solutions, especially for the use of merchandising purposes by generating QR codes from the specification-regulated protocol scheme described below.
ts syntax follows RFC 3986. See [URI scheme](https://en.wikipedia.org/wiki/URI_scheme) for explanation. Spaces must be [x-www-urlencoded](https://en.wikipedia.org/wiki/Application/x-www-form-urlencoded) as `%20`.
## Main format:
```
monero: [address <string>]
```
The following parameters can be optionally appended to the resulting URI:
| Parameter | Type | Kind | Description |
|:---------------|:------:|:----:|:------------|
| address | String | hierarch.| The raw address (or the openalias?).|
| tx_payment_id | String | ? | The proposed payment ID of the transaction. |
| recipient_name | String | ? | The proposed contact name of the recipient. |
| tx_amount | Float | query | The proposed amount of the transaction in atomic currency units. |
| tx_description | String | fragment | Describes the transaction which should be initiated. |
Thus the resulting URI may look something like this:
```
monero:46BeWrHpwXmHDpDEUmZBWZfoQpdc6HaERCNmx1pEYL2rAcuwufPN9rXHHtyUA4QVy66qeFQkn6sfK8aHYjA3jk3o1Bv16em?tx_amount=239.39014&tx_description=donation
```