Difference between revisions of "Outputs (Voting Pool Wallet API)"

From Open Transactions
Jump to navigation Jump to search
(outBailmentID is an object, not a string)
m (too early...)
Line 35: Line 35:
 
}
 
}
 
</pre></code>
 
</pre></code>
 
==Canonical Location==
 
 
https://github.com/Open-Transactions/rfc/blob/draft/json/schema/outputlist-01.json
 
  
 
[[Category:Voting Pool Technical Specifications]]
 
[[Category:Voting Pool Technical Specifications]]

Revision as of 15:06, 26 September 2014

The startwithdrawal API call accepts a list of outputs to be created since voting pools process withdrawals in batches.

The list is formated as a JSON object.

Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Output list",
    "description": "A list of outputs to be created from a round of voting pool outBailment consensus",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "outBailmentID": {
                "$ref": "https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/schema/outbailmentid-01.json",
                "description": "the identifier of the originating nym's outBailment message"
            },
            "address": {
                "type": "string",
                "description": "the destination address for the outBailment"
            },
            "amount": {
                "type": "number",
                "description": "the monetary value of the outBailment, in fundamental units (satoshis for Bitcoin)",
                "minimum": 0,
                "exclusiveMinimum": true
            }
        },
        "required": [ "outBailmentID","address","amount" ]
    },
    "minItems": 1,
    "uniqueItems": true
}