Withdrawal status

The startwithdrawal API call returns a list of accounting and status information corresponding to the transactions which it has created.

The list is formated as a JSON object.

Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Withdrawal status list",
    "description": "Accounting and status information corresponding to a voting pool outBailment consensus round",
    "type": "object",
    "properties": {
        "roundID" {
            "type": "number",
            "description": "A positive integer representing the consensus round for which the withdrawal is associated",
            "minimum": 0,
            "exclusiveMinimum": false
        },
        "nextinputstart" {
            "description": "The inputstart value to be used in the next consensus round as an address identifier",
            "$ref": "TBD"
        },
        "nextchangestart" {
            "description": "The changestart value to be used in the next consensus round as an address identifier",
            "$ref": "TBD"
        },
        "fees" {
            "type": "number",
            "description": "Total transaction fees incurred by the transactions in this round",
            "minimum": 0,
            "exclusiveMinimum": false
        },
        "outputs" {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "outBailmentID" {
                        "type": "string",
                        "description": "the identifier of the originating nym's outBailment message"
                    },
                    "status" {
                        "type": "string",
                        "description": "Status code for the outBailment"
                    },
                    "transactions" {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "ntxid" {
                                    "type": "string",
                                    "description": "Normalized transaction id associated with the withdrawal"
                                }
                                "index" {
                                    "type": "number",
                                    "description": "Output index in transaction which satisfies this outBailmentID",
                                    "minimum": 0,
                                    "exclusiveMinimum": false
                                }
                                "amount" {
                                    "type": "number",
                                    "description": "Monetary value of the output given by the (ntxid,index), in fundamental units",
                                    "minimum": 0,
                                    "exclusiveMinimum": true
                                }
                            }
                        }
                       "minItems": 0,
                       "uniqueItems": true
                    },
                    "required": [ "outBailmentID","status" ]
                }
            }
            "minItems": 1,
            "uniqueItems": true
        },
        "required": [ "nextinputstart","nextchangestart","fees","outputs"]
    }
}