Struct X402BatchSettlementClaim 

pub struct X402BatchSettlementClaim {
    pub signature: X402BatchSettlementClaimSignature,
    pub total_claimed: X402BatchSettlementClaimTotalClaimed,
    pub voucher: X402BatchSettlementClaimVoucher,
}

A single voucher claim within a batched on-chain claim transaction. Used by x402BatchSettlementClaimPayload.claims and by the server-enriched shape of x402BatchSettlementRefundPayload.claims. NOTE: the nested voucher here has a different shape from the top-level x402BatchSettlementVoucher schema. The top-level voucher is the signed cumulative-ceiling message sent by a client ({channelId, maxClaimableAmount, signature}). This nested voucher mirrors the on-chain claim struct ({channel: ChannelConfig, maxClaimableAmount}) that participates in the EIP-712 hash, with signature and totalClaimed as siblings rather than nested fields. The field names match the upstream x402 protocol and the on-chain Solidity struct; they cannot be renamed without breaking wire and EIP-712 compatibility.

JSON schema

{
 "title": "x402BatchSettlementClaim",
 "description": "A single voucher claim within a batched on-chain claim transaction. Used by `x402BatchSettlementClaimPayload.claims` and by the server-enriched shape of `x402BatchSettlementRefundPayload.claims`.\nNOTE: the nested `voucher` here has a **different shape** from the top-level `x402BatchSettlementVoucher` schema. The top-level voucher is the signed cumulative-ceiling message sent by a client (`{channelId, maxClaimableAmount, signature}`). This nested `voucher` mirrors the on-chain claim struct (`{channel: ChannelConfig, maxClaimableAmount}`) that participates in the EIP-712 hash, with `signature` and `totalClaimed` as siblings rather than nested fields. The field names match the upstream x402 protocol and the on-chain Solidity struct; they cannot be renamed without breaking wire and EIP-712 compatibility.",
 "examples": [
   {
     "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f134801234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1b",
     "totalClaimed": "3000000",
     "voucher": {
       "channel": {
         "payer": "0x857b06519E91e3A54538791bDbb0E22373e36b66",
         "payerAuthorizer": "0x857b06519E91e3A54538791bDbb0E22373e36b66",
         "receiver": "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
         "receiverAuthorizer": "0x1111111111111111111111111111111111111111",
         "salt": "0x0000000000000000000000000000000000000000000000000000000000000001",
         "token": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
         "withdrawDelay": 86400
       },
       "maxClaimableAmount": "5000000"
     }
   }
 ],
 "type": "object",
 "required": [
   "signature",
   "totalClaimed",
   "voucher"
 ],
 "properties": {
   "signature": {
     "description": "The voucher signature from `payerAuthorizer`.",
     "type": "string",
     "pattern": "^0x[0-9a-fA-F]+$"
   },
   "totalClaimed": {
     "description": "The cumulative amount already claimed from this channel as of this claim.",
     "examples": [
       "3000000"
     ],
     "type": "string",
     "pattern": "^[0-9]+$"
   },
   "voucher": {
     "description": "The voucher to claim, identified by the channel config it was signed against and its cumulative ceiling. Field shape mirrors the on-chain claim struct.",
     "type": "object",
     "required": [
       "channel",
       "maxClaimableAmount"
     ],
     "properties": {
       "channel": {
         "$ref": "#/components/schemas/x402BatchSettlementChannelConfig"
       },
       "maxClaimableAmount": {
         "description": "The cumulative maximum claimable amount (uint128 as decimal string) signed by the payer authorizer.",
         "examples": [
           "5000000"
         ],
         "type": "string",
         "pattern": "^[0-9]+$"
       }
     }
   }
 }
}

Fields

signature: X402BatchSettlementClaimSignature

The voucher signature from payerAuthorizer.

total_claimed: X402BatchSettlementClaimTotalClaimed

The cumulative amount already claimed from this channel as of this claim.

voucher: X402BatchSettlementClaimVoucher

Implementations

impl X402BatchSettlementClaim

pub fn builder() -> X402BatchSettlementClaim

Trait Implementations

impl Clone for X402BatchSettlementClaim

fn clone(&self) -> X402BatchSettlementClaim

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for X402BatchSettlementClaim

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for X402BatchSettlementClaim

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&X402BatchSettlementClaim> for X402BatchSettlementClaim

fn from(value: &X402BatchSettlementClaim) -> Self

Converts to this type from the input type.

impl From<X402BatchSettlementClaim> for X402BatchSettlementClaim

fn from(value: X402BatchSettlementClaim) -> Self

Converts to this type from the input type.

impl Serialize for X402BatchSettlementClaim

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<X402BatchSettlementClaim> for X402BatchSettlementClaim

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: X402BatchSettlementClaim) -> Result<Self, ConversionError>

Performs the conversion.