Struct AuthenticatedPaymentRequest 

pub struct AuthenticatedPaymentRequest {
    pub user_id: String,
    pub session_id: Option<String>,
    pub tenant_id: Option<String>,
    pub scopes: Vec<String>,
    pub metadata: Map<String, Value>,
}

Available on crate feature payments only.

Authenticated request identity carried into payment tools or endpoints.

This type intentionally keeps request identity separate from the durable session identity stored on a transaction and from the protocol actor roles recorded in commerce payloads.

Example

use adk_payments::auth::{AuthenticatedPaymentRequest, PaymentOperation};

let request = AuthenticatedPaymentRequest::new("alice")
    .with_tenant_id("tenant-1")
    .with_scopes(["payments:checkout:update"]);

request
    .check_operation_scopes(PaymentOperation::UpdateCheckout)
    .unwrap();

Fields

user_id: String

session_id: Option<String>

tenant_id: Option<String>

scopes: Vec<String>

metadata: Map<String, Value>

Implementations

impl AuthenticatedPaymentRequest

pub fn new(user_id: impl Into<String>) -> AuthenticatedPaymentRequest

Creates a new authenticated payment request capsule.

pub fn with_session_id( self, session_id: impl Into<String>, ) -> AuthenticatedPaymentRequest

Attaches the caller’s session identifier.

pub fn with_tenant_id( self, tenant_id: impl Into<String>, ) -> AuthenticatedPaymentRequest

Attaches the caller’s tenant identifier.

pub fn with_scopes<I, S>(self, scopes: I) -> AuthenticatedPaymentRequest

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the granted scope list.

pub fn with_metadata( self, key: impl Into<String>, value: Value, ) -> AuthenticatedPaymentRequest

Adds one metadata field preserved alongside the authenticated request.

pub fn check_operation_scopes( &self, operation: PaymentOperation, ) -> Result<(), PaymentsAuthError>

Checks that the request scopes authorize one payment operation.

Errors

Returns PaymentsAuthError::MissingScopes when the request is missing one or more required scopes.

pub fn assert_transaction_binding( &self, record: &TransactionRecord, ) -> Result<(), PaymentsAuthError>

Rejects attempts to access a transaction with conflicting identity or tenant bindings.

Errors

Returns PaymentsAuthError::IdentityConflict when the authenticated request tries to rebind the durable session or tenant association of an existing transaction.

Trait Implementations

impl Clone for AuthenticatedPaymentRequest

fn clone(&self) -> AuthenticatedPaymentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticatedPaymentRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthenticatedPaymentRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<AuthenticatedPaymentRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuthenticatedPaymentRequest

fn eq(&self, other: &AuthenticatedPaymentRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AuthenticatedPaymentRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthenticatedPaymentRequest