174 lines
3.8 KiB
JSON
174 lines
3.8 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [ "payments" ],
|
|
"properties": {
|
|
"payments": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": true,
|
|
"required": [ "id", "payment_hash", "status", "created_at", "amount_sent_msat" ],
|
|
"properties": {
|
|
"id": {
|
|
"type": "u64",
|
|
"description": "unique ID for this payment attempt"
|
|
},
|
|
"groupid": {
|
|
"type": "u64",
|
|
"description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash"
|
|
},
|
|
"payment_hash": {
|
|
"type": "hex",
|
|
"description": "the hash of the *payment_preimage* which will prove payment",
|
|
"maxLength": 64,
|
|
"minLength": 64
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [ "pending", "failed", "complete" ],
|
|
"description": "status of the payment"
|
|
},
|
|
"msatoshi": {
|
|
"deprecated": true
|
|
},
|
|
"amount_msat": {
|
|
"type": "msat",
|
|
"description": "The amount delivered to destination (if known)"
|
|
},
|
|
"destination": {
|
|
"type": "pubkey",
|
|
"description": "the final destination of the payment if known"
|
|
},
|
|
"created_at": {
|
|
"type": "u64",
|
|
"description": "the UNIX timestamp showing when this payment was initiated"
|
|
},
|
|
"msatoshi_sent": {
|
|
"deprecated": true
|
|
},
|
|
"amount_sent_msat": {
|
|
"type": "msat",
|
|
"description": "The amount sent"
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": "the label, if given to sendpay"
|
|
},
|
|
"bolt11": {
|
|
"type": "string",
|
|
"description": "the bolt11 string (if pay supplied one)"
|
|
},
|
|
"bolt12": {
|
|
"type": "string",
|
|
"description": "the bolt12 string (if supplied for pay: **experimental-offers** only)."
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"if": {
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [ "complete" ]
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"additionalProperties": false,
|
|
"required": [ "payment_preimage" ],
|
|
"properties": {
|
|
"id": { },
|
|
"partid": { },
|
|
"groupid": { },
|
|
"payment_hash": { },
|
|
"status": { },
|
|
"msatoshi": { },
|
|
"amount_msat": { },
|
|
"destination": { },
|
|
"created_at": { },
|
|
"msatoshi_sent": { },
|
|
"amount_sent_msat": { },
|
|
"label": { },
|
|
"bolt11": { },
|
|
"bolt12": { },
|
|
"payment_preimage": {
|
|
"type": "hex",
|
|
"description": "the proof of payment: SHA256 of this **payment_hash**",
|
|
"maxLength": 64,
|
|
"minLength": 64
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"if": {
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [ "failed" ]
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"additionalProperties": false,
|
|
"required": [ ],
|
|
"properties": {
|
|
"id": { },
|
|
"partid": { },
|
|
"groupid": { },
|
|
"payment_hash": { },
|
|
"status": { },
|
|
"msatoshi": { },
|
|
"amount_msat": { },
|
|
"destination": { },
|
|
"created_at": { },
|
|
"msatoshi_sent": { },
|
|
"amount_sent_msat": { },
|
|
"label": { },
|
|
"bolt11": { },
|
|
"bolt12": { },
|
|
"erroronion": {
|
|
"type": "hex",
|
|
"description": "the onion message returned"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"if": {
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [ "pending" ]
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"additionalProperties": false,
|
|
"required": [ ],
|
|
"properties": {
|
|
"id": { },
|
|
"partid": { },
|
|
"groupid": { },
|
|
"payment_hash": { },
|
|
"status": { },
|
|
"msatoshi": { },
|
|
"amount_msat": { },
|
|
"destination": { },
|
|
"created_at": { },
|
|
"msatoshi_sent": { },
|
|
"amount_sent_msat": { },
|
|
"label": { },
|
|
"bolt11": { },
|
|
"bolt12": { }
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|