Outputs (Voting Pool Wallet API)

From Open Transactions
Revision as of 14:38, 9 September 2014 by Justusranvier (talk | contribs) (Initial page creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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" {
                "type": string,
                "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
}