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.
Its syntax follows RFC 3986. See URI scheme for explanation. Spaces must be x-www-urlencoded as %20.
TX Scheme
The following parameters can be optionally appended to the resulting URI:
| Parameter |
Type |
Kind |
Description |
address |
String |
hierarch. |
The raw address (or the openalias?). Multiple addresses can be provided if separated by a semicolon (;). |
recipient_name |
String |
? |
The proposed contact name of the recipient. Multiple names can be provided if separated by a semicolon (;). |
tx_amount |
String |
query |
The proposed amount of the transaction in decimal units. Multiple amounts can be provided if separated by a semicolon (;). |
tx_description |
String |
fragment |
Describes the transaction which should be initiated. |
Note: If multiple address parameters are supplied, there must be a matching number of tx_amount parameters.
Note: The tx_payment_id parameter was supported in earlier versions of this specification but is now deprecated and no longer allowed for manual inclusion.
Thus the resulting URI may look something like this:
or
Wallet Definition Scheme
The following scheme is proposed as a means of describing wallets. This scheme may be used for restoring.
Only one of seed and (spend_key,view_key) may/must be specified.
| Parameter |
Type |
Requires |
Description |
address |
String |
view_key |
Raw (95-character) address |
spend_key |
Hex String |
address, view_key |
Private spend key of a wallet. |
view_key |
Hex String |
address, absence of seed |
Private view key of a wallet. |
seed |
String |
Absence of view_key |
URL encoded mnemonic seed to restore a deterministic wallet. |
height |
Long |
Absence of txid |
Block height when the wallet was created. |
txid |
String |
Absence of height |
Transaction ID(s) to scan. Multiple transaction IDs can be provided if separated by a semicolon (;). |
Note: The seed parameter was named mnemonic_seed in earlier versions of this specification.
The resulting URI for a wallet may look like this:
or