core-lightning/doc/schemas/pay.schema.json
2022-04-02 09:46:01 +10:30

68 lines
1.6 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"payment_preimage",
"payment_hash",
"created_at",
"parts",
"amount_msat",
"amount_sent_msat",
"status"
],
"properties": {
"payment_preimage": {
"type": "hex",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64
},
"destination": {
"type": "pubkey",
"description": "the final destination of the payment"
},
"payment_hash": {
"type": "hex",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
},
"created_at": {
"type": "number",
"description": "the UNIX timestamp showing when this payment was initiated"
},
"parts": {
"type": "u32",
"description": "how many attempts this took"
},
"msatoshi": {
"deprecated": true
},
"amount_msat": {
"type": "msat",
"description": "Amount the recipient received"
},
"msatoshi_sent": {
"deprecated": true
},
"amount_sent_msat": {
"type": "msat",
"description": "Total amount we sent (including fees)"
},
"warning_partial_completion": {
"type": "string",
"description": "Not all parts of a multi-part payment have completed"
},
"status": {
"type": "string",
"enum": [
"complete",
"pending",
"failed"
],
"description": "status of payment"
}
}
}