adk-payments 0.6.0

Protocol-neutral agentic commerce and payment orchestration for ADK-Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! AP2 payment request and response types aligned to `v0.1-alpha`.
//!
//! Structures are loosely aligned with the W3C PaymentRequest model while
//! carrying AP2-specific risk and extension data.

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::domain::{Money, ProtocolExtensions};

/// W3C PaymentRequest-aligned structure for AP2 payment initiation.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2PaymentRequest {
    /// Unique request identifier.
    pub id: String,
    /// Accepted payment method data (method identifiers and configuration).
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub method_data: Vec<Ap2PaymentMethodData>,
    /// Payment details including total and display items.
    pub details: Ap2PaymentDetails,
    /// Optional payment options (e.g. shipping, contact info requests).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub options: Option<Ap2PaymentOptions>,
    /// Risk assessment data attached to this request.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub risk_data: Option<Ap2RiskData>,
    /// Protocol-specific extension fields.
    #[serde(default, skip_serializing_if = "ProtocolExtensions::is_empty")]
    pub extensions: ProtocolExtensions,
}

/// Payment method identifier and optional configuration.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2PaymentMethodData {
    /// Payment method identifier (e.g. `"basic-card"`, `"https://pay.example"`).
    pub supported_methods: String,
    /// Optional method-specific configuration.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data: Option<Value>,
}

/// Payment details including total and optional display items.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2PaymentDetails {
    /// Total amount for the payment.
    pub total: Money,
    /// Optional display line items.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub display_items: Vec<Ap2DisplayItem>,
}

/// A single display item within payment details.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2DisplayItem {
    /// Label for the display item.
    pub label: String,
    /// Amount for this item.
    pub amount: Money,
}

/// Optional payment options controlling what information is requested.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2PaymentOptions {
    /// Whether shipping address is requested.
    #[serde(default)]
    pub request_shipping: bool,
    /// Whether payer email is requested.
    #[serde(default)]
    pub request_payer_email: bool,
    /// Whether payer phone is requested.
    #[serde(default)]
    pub request_payer_phone: bool,
    /// Whether payer name is requested.
    #[serde(default)]
    pub request_payer_name: bool,
}

/// AP2 payment response returned after payment method selection.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2PaymentResponse {
    /// Unique response identifier.
    pub id: String,
    /// The payment method name used.
    pub method_name: String,
    /// Method-specific response details.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub details: Option<Value>,
    /// Payer email if provided.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub payer_email: Option<String>,
    /// Payer phone if provided.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub payer_phone: Option<String>,
    /// Payer name if provided.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub payer_name: Option<String>,
    /// Protocol-specific extension fields.
    #[serde(default, skip_serializing_if = "ProtocolExtensions::is_empty")]
    pub extensions: ProtocolExtensions,
}

/// Risk assessment container attached to AP2 payment flows.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ap2RiskData {
    /// Risk score (0–100, higher = riskier).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub score: Option<u32>,
    /// Risk assessment source.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// Recommended action based on risk assessment.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub action: Option<String>,
    /// Additional risk signals.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub signals: Vec<Value>,
    /// Protocol-specific extension fields.
    #[serde(default, skip_serializing_if = "ProtocolExtensions::is_empty")]
    pub extensions: ProtocolExtensions,
}