X402PaymentPayload

cdp_sdk::api::types

Struct X402PaymentPayload

pub struct X402PaymentPayload {
    pub network: X402PaymentPayloadNetwork,
    pub payload: X402ExactEvmPayload,
    pub scheme: X402PaymentPayloadScheme,
    pub x402_version: X402Version,
}

Expand description

The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header.

JSON schema

{
 "description": "The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header.",
 "examples": [
   {
     "network": "base",
     "payload": {
       "authorization": {
         "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
         "nonce": "0x1234567890abcdef1234567890abcdef12345678",
         "to": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
         "validAfter": "1716150000",
         "validBefore": "1716150000",
         "value": "1000000000000000000"
       },
       "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480"
     },
     "scheme": "exact",
     "x402Version": 1
   }
 ],
 "type": "object",
 "required": [
   "network",
   "payload",
   "scheme",
   "x402Version"
 ],
 "properties": {
   "network": {
     "description": "The network of the blockchain to send payment on.",
     "examples": [
       "base"
     ],
     "type": "string",
     "enum": [
       "base-sepolia",
       "base"
     ]
   },
   "payload": {
     "description": "The payload of the payment depending on the x402Version, scheme, and network.",
     "examples": [
       {
         "authorization": {
           "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
           "nonce": "0x1234567890abcdef1234567890abcdef12345678",
           "to": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
           "validAfter": "1716150000",
           "validBefore": "1716150000",
           "value": "1000000000000000000"
         },
         "signature": "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480"
       }
     ],
     "type": "object",
     "oneOf": [
       {
         "$ref": "#/components/schemas/x402ExactEvmPayload"
       }
     ]
   },
   "scheme": {
     "description": "The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`.",
     "examples": [
       "exact"
     ],
     "type": "string",
     "enum": [
       "exact"
     ]
   },
   "x402Version": {
     "$ref": "#/components/schemas/X402Version"
   }
 }
}

Fields§

§network: X402PaymentPayloadNetwork

The network of the blockchain to send payment on.

§payload: X402ExactEvmPayload

The payload of the payment depending on the x402Version, scheme, and network.

§scheme: X402PaymentPayloadScheme

The scheme of the payment protocol to use. Currently, the only supported scheme is exact.

§x402_version: X402Version

Implementations§

impl X402PaymentPayload

pub fn builder() -> X402PaymentPayload

Trait Implementations§

impl Clone for X402PaymentPayload

fn clone(&self) -> X402PaymentPayload

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for X402PaymentPayload

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for X402PaymentPayload

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<&X402PaymentPayload> for X402PaymentPayload

fn from(value: &X402PaymentPayload) -> Self

Converts to this type from the input type.

impl From<X402PaymentPayload> for X402PaymentPayload

fn from(value: X402PaymentPayload) -> Self

Converts to this type from the input type.

impl Serialize for X402PaymentPayload

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl TryFrom<X402PaymentPayload> for X402PaymentPayload

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

Auto Trait Implementations§

impl Freeze for X402PaymentPayload

impl RefUnwindSafe for X402PaymentPayload

impl Send for X402PaymentPayload

impl Sync for X402PaymentPayload

impl Unpin for X402PaymentPayload

impl UnwindSafe for X402PaymentPayload

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,