Class PaymentRequirement

One entry of the 402 challenge's accepts array (t54 exact scheme). Describes a single payment option the server is willing to accept.

Inheritance

object

PaymentRequirement

Namespace: Xrpl.X402.Wire

Assembly: Xrpl.X402.dll

Syntax

public sealed class PaymentRequirement

Properties

Amount

Exact amount to pay. For XRP, this is drops as a decimal string; for IOUs, it is the token value string.

Declaration

[JsonPropertyName("amount")]
public string Amount { get; set; }

Property Value

Type	Description
string

Asset

Asset ticker the payment must be denominated in, e.g. "XRP" or "RLUSD".

Declaration

[JsonPropertyName("asset")]
public string Asset { get; set; }

Property Value

Type	Description
string

Extra

Arbitrary extension data supplied by the server, such as invoiceId, sessionId, sourceTag, and issuer (required for IOU assets). A null JSON value is normalized to an empty dictionary so consumers never dereference null.

Declaration

[JsonPropertyName("extra")]
public Dictionary<string, JsonElement> Extra { get; set; }

Property Value

Type	Description
Dictionary<string, JsonElement>

MaxTimeoutSeconds

Maximum number of seconds from now within which the signed transaction must be validated. Maps to an upper bound on LastLedgerSequence.

Declaration

[JsonPropertyName("maxTimeoutSeconds")]
public int MaxTimeoutSeconds { get; set; }

Property Value

Type	Description
int

Network

CAIP-2 network identifier, e.g. "xrpl:1" for XRPL Mainnet.

Declaration

[JsonPropertyName("network")]
public string Network { get; set; }

Property Value

Type	Description
string

PayTo

Classic XRPL address that receives the payment.

Declaration

[JsonPropertyName("payTo")]
public string PayTo { get; set; }

Property Value

Type	Description
string

Scheme

Payment scheme identifier; always "exact" for the t54 XRPL exact scheme.

Declaration

[JsonPropertyName("scheme")]
public string Scheme { get; set; }

Property Value

Type	Description
string