Struct Payment

pub struct Payment {

    pub transaction_id: String,
    pub thid: Option<String>,
    pub pthid: Option<String>,
    pub merchant: Participant,
    pub customer: Participant,
    pub asset: AssetId,
    pub amount: String,
    pub order_details: Option<HashMap<String, Value>>,
    pub timestamp: String,
    pub expires: Option<String>,
    pub note: Option<String>,
    pub agents: Vec<Participant>,
    pub metadata: HashMap<String, Value>,
    pub attachments: Option<Vec<Attachment>>,
}

Represents a TAP Payment message. This message type is used to initiate a payment request.

Fields

transaction_id: String

Unique identifier for this payment request.

thid: Option<String>

Identifier for the thread this message belongs to.

pthid: Option<String>

Identifier for the parent thread, used for replies.

merchant: Participant

The merchant requesting the payment.

customer: Participant

The customer making the payment.

asset: AssetId

The asset being transferred (e.g., currency and amount).

amount: String

The amount requested for payment.

order_details: Option<HashMap<String, Value>>

Optional details about the order or transaction.

timestamp: String

Timestamp when the payment request was created (RFC3339).

expires: Option<String>

Optional expiry time for the payment request (RFC3339).

note: Option<String>

Optional note from the merchant.

agents: Vec<Participant>

Optional list of agents involved in processing the payment.

metadata: HashMap<String, Value>

Optional metadata associated with the payment.

attachments: Option<Vec<Attachment>>

Optional attachments.

Implementations

impl Payment

Helper methods for the Payment struct

pub fn message_id(&self) -> String

Generates a unique message ID for authorization, rejection, or settlement

pub fn require_proof_of_control( &self, _agent: String, _challenge: String, ) -> RequireProofOfControl

Requires proof of control from a specific agent

Trait Implementations

impl Authorizable for Payment

fn authorize(&self, note: Option<String>) -> Authorize

Authorizes this message, creating an Authorize message as a response

fn confirm_relationship( &self, transaction_id: String, agent_id: String, for_id: String, role: Option<String>, ) -> ConfirmRelationship

Confirms a relationship between agents, creating a ConfirmRelationship message as a response

fn reject(&self, code: String, description: String) -> Reject

Rejects this message, creating a Reject message as a response

fn settle(&self, settlement_id: String, amount: Option<String>) -> Settle

Settles this message, creating a Settle message as a response

fn update_party( &self, transaction_id: String, party_type: String, party: Participant, note: Option<String>, ) -> UpdateParty

Updates a party in the transaction, creating an UpdateParty message as a response

fn update_policies( &self, transaction_id: String, policies: Vec<Policy>, ) -> UpdatePolicies

Updates policies for this message, creating an UpdatePolicies message as a response

fn add_agents( &self, transaction_id: String, agents: Vec<Participant>, ) -> AddAgents

Adds agents to this message, creating an AddAgents message as a response

fn replace_agent( &self, transaction_id: String, original: String, replacement: Participant, ) -> ReplaceAgent

Replaces an agent in this message, creating a ReplaceAgent message as a response

fn remove_agent(&self, transaction_id: String, agent: String) -> RemoveAgent

Removes an agent from this message, creating a RemoveAgent message as a response

impl Clone for Payment

fn clone(&self) -> Payment

Returns a copy of the value.

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

Performs copy-assignment from source.

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 PartialEq for Payment

fn eq(&self, other: &Payment) -> 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 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<Message>

Create a reply to this message.

fn message_type(&self) -> &'static str

Get the message type for 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: Option<&str>) -> Result<Message>

Convert this body to a DIDComm message.

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

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

Convert this body to a DIDComm message with a sender and multiple recipients.

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

where Self: Sized,

Extract this body type from a DIDComm message.

impl StructuralPartialEq for Payment