Struct Payment

pub struct Payment {

    pub asset: Option<AssetId>,
    pub amount: String,
    pub currency_code: Option<String>,
    pub supported_assets: Option<Vec<AssetId>>,
    pub customer: Option<Party>,
    pub merchant: Party,
    pub transaction_id: String,
    pub memo: Option<String>,
    pub expiry: Option<String>,
    pub invoice: Option<Invoice>,
    pub agents: Vec<Agent>,
    pub connection_id: Option<String>,
    pub metadata: HashMap<String, Value>,
}

Payment message body (TAIP-14).

A Payment is a DIDComm message initiated by the merchant’s agent and sent to the customer’s agent to request a blockchain payment. It must include either an asset or a currency to denominate the payment, along with the amount and recipient information.

Fields

asset: Option<AssetId>

Asset identifier (CAIP-19 format).

amount: String

Payment amount.

currency_code: Option<String>

Currency code for fiat amounts (e.g., USD).

supported_assets: Option<Vec<AssetId>>

Supported assets for this payment (when currency_code is specified)

customer: Option<Party>

Customer (payer) details.

merchant: Party

Merchant (payee) details.

transaction_id: String

Transaction identifier.

memo: Option<String>

Memo for the payment (optional).

expiry: Option<String>

Expiration time in ISO 8601 format (optional).

invoice: Option<Invoice>

Invoice details (optional) per TAIP-16

agents: Vec<Agent>

Other agents involved in the payment.

connection_id: Option<String>

Connection ID for linking to Connect messages

metadata: HashMap<String, Value>

Additional metadata (optional).

Implementations

impl Payment

pub fn with_asset( asset: AssetId, amount: String, merchant: Party, agents: Vec<Agent>, ) -> Self

Creates a new Payment with an asset

pub fn with_currency( currency_code: String, amount: String, merchant: Party, agents: Vec<Agent>, ) -> Self

Creates a new Payment with a currency

pub fn with_currency_and_assets( currency_code: String, amount: String, supported_assets: Vec<AssetId>, merchant: Party, agents: Vec<Agent>, ) -> Self

Creates a new Payment with a currency and supported assets

pub fn validate(&self) -> Result<()>

Custom validation for Payment messages

Trait Implementations

impl Authorizable for Payment

fn authorize( &self, creator_did: &str, settlement_address: Option<&str>, expiry: Option<&str>, ) -> PlainMessage<Authorize>

Create an Authorize message for this object (TAIP-4).

fn cancel( &self, creator_did: &str, by: &str, reason: Option<&str>, ) -> PlainMessage<Cancel>

Create a Cancel message for this object (TAIP-4).

fn reject(&self, creator_did: &str, reason: &str) -> PlainMessage<Reject>

Create a Reject message for this object (TAIP-4).

impl Clone for Payment

fn clone(&self) -> Payment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Connectable for Payment

fn with_connection(&mut self, connection_id: &str) -> &mut Self

Connect this message to a prior Connect message by setting the parent thread ID (pthid).

fn has_connection(&self) -> bool

Check if this message is connected to a prior Connect message.

fn connection_id(&self) -> Option<&str>

Get the connection ID if present.

impl Debug for Payment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Payment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MessageContext for Payment

fn participant_dids(&self) -> Vec<String>

Extract all participant DIDs from the message This replaces the old participants() method and works with Agent/Party types directly

fn transaction_context(&self) -> Option<TransactionContext>

Get transaction context if applicable

fn routing_hints(&self) -> RoutingHints

Get routing hints for message delivery

fn transaction_id(&self) -> Option<String>

Get transaction ID if available

impl Serialize for Payment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessage for Payment

fn validate(&self) -> Result<()>

Validates a TAP message.

fn is_tap_message(&self) -> bool

Checks if this message is a TAP message.

fn get_tap_type(&self) -> Option<String>

Gets the TAP message type from this message.

fn body_as<T: TapMessageBody>(&self) -> Result<T>

Extract a specific message body type from this message.

fn get_all_participants(&self) -> Vec<String>

Get all participant DIDs from this message.

fn create_reply<T: TapMessageBody>( &self, body: &T, creator_did: &str, ) -> Result<PlainMessage>

Create a reply to this message.

fn thread_id(&self) -> Option<&str>

Get the thread ID for this message

fn parent_thread_id(&self) -> Option<&str>

Get the parent thread ID for this message

fn message_id(&self) -> &str

Get the message ID for this message

impl TapMessageBody for Payment

fn message_type() -> &'static str

Get the message type string for this body type.

fn validate(&self) -> Result<()>

Validate the message body.

fn to_didcomm(&self, from_did: &str) -> Result<PlainMessage>

Convert this body to a DIDComm message.

fn to_didcomm_with_route<'a, I>( &self, from: &str, to: I, ) -> Result<PlainMessage>

where I: IntoIterator<Item = &'a str>,

Convert this body to a DIDComm message with a custom routing path.

fn from_didcomm(message: &PlainMessage) -> Result<Self>

where Self: Sized,

Extract this body type from a DIDComm message.

impl Transaction for Payment

fn settle( &self, creator_did: &str, settlement_id: &str, amount: Option<&str>, ) -> PlainMessage<Settle>

Create a Settle message for this object (TAIP-4).

fn revert( &self, creator_did: &str, settlement_address: &str, reason: &str, ) -> PlainMessage<Revert>

Create a Revert message for this object (TAIP-4).

fn add_agents( &self, creator_did: &str, agents: Vec<Agent>, ) -> PlainMessage<AddAgents>

Create an AddAgents message for this object (TAIP-5).

fn replace_agent( &self, creator_did: &str, original_agent: &str, replacement: Agent, ) -> PlainMessage<ReplaceAgent>

Create a ReplaceAgent message for this object (TAIP-5).

fn remove_agent( &self, creator_did: &str, agent: &str, ) -> PlainMessage<RemoveAgent>

Create a RemoveAgent message for this object (TAIP-5).

fn update_party( &self, creator_did: &str, party_type: &str, party: Party, ) -> PlainMessage<UpdateParty>

Create an UpdateParty message for this object (TAIP-6).

fn update_policies( &self, creator_did: &str, policies: Vec<Policy>, ) -> PlainMessage<UpdatePolicies>

Create an UpdatePolicies message for this object (TAIP-7).

fn confirm_relationship( &self, creator_did: &str, agent_did: &str, relationship_type: &str, ) -> PlainMessage<ConfirmRelationship>

Create a ConfirmRelationship message for this object (TAIP-9).