rgb-cln/doc/schemas/delpay.schema.json

103 lines
3.1 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"payments"
],
"additionalProperties": false,
"properties": {
"payments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"created_index",
"id",
"payment_hash",
"status",
"amount_sent_msat",
"created_at"
],
"properties": {
"created_index": {
"added": "v23.11",
"type": "u64",
"description": "1-based index indicating order this payment was created in"
},
"id": {
"type": "u64",
"description": "old synonym for created_index"
},
"payment_hash": {
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment"
},
"status": {
"type": "string",
"enum": [
"pending",
"failed",
"complete"
],
"description": "status of the payment"
},
"amount_sent_msat": {
"type": "msat",
"description": "the amount we actually sent, including fees"
},
"partid": {
"type": "u64",
"description": "unique ID within this (multi-part) payment"
},
"destination": {
"type": "pubkey",
"description": "the final destination of the payment if known"
},
"amount_msat": {
"type": "msat",
"description": "the amount the destination received, if known"
},
"created_at": {
"type": "u64",
"description": "the UNIX timestamp showing when this payment was initiated"
},
"updated_index": {
"added": "v23.11",
"type": "u64",
"description": "1-based index indicating order this payment was changed (only present if it has changed since creation)"
},
"completed_at": {
"type": "u64",
"description": "the UNIX timestamp showing when this payment was completed"
},
"groupid": {
"type": "u64",
"description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash"
},
"payment_preimage": {
"type": "secret",
"description": "proof of payment"
},
"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)."
},
"erroronion": {
"type": "hex",
"description": "the error onion returned on failure, if any."
}
}
}
}
}
}