Improve doc of payment requests

This commit is contained in:
nicolas.dorier
2025-04-09 18:57:31 +09:00
parent ba9646f486
commit b7524e3587
2 changed files with 14 additions and 1 deletions

View File

@@ -9,9 +9,21 @@ namespace BTCPayServer.Client.Models
{ {
public enum PaymentRequestStatus public enum PaymentRequestStatus
{ {
/// <summary>
/// Not enough has been paid or settled
/// </summary>
Pending, Pending,
/// <summary>
/// Paid and fully settled
/// </summary>
Completed, Completed,
/// <summary>
/// Expired before full settlement
/// </summary>
Expired, Expired,
/// <summary>
/// Paid enough, awaiting full settlement
/// </summary>
Processing, Processing,
} }
public class PaymentRequestBaseData public class PaymentRequestBaseData

View File

@@ -396,9 +396,10 @@
"enum": [ "enum": [
"Pending", "Pending",
"Completed", "Completed",
"Processing",
"Expired" "Expired"
], ],
"description": "The status of the payment request", "description": "Represents the status of a payment request:\n* `Pending`: Not enough has been paid or settled.\n* `Completed`: Paid and fully settled.\n* `Expired`: Expired before full settlement.\n* `Processing`: Paid enough, awaiting full settlement.",
"nullable": false "nullable": false
}, },
"createdTime": { "createdTime": {