Struct PaymentRequest

pub struct PaymentRequest {
    pub asset: Option<AssetId>,
    pub currency: Option<String>,
    pub amount: String,
    pub supported_assets: Option<Vec<String>>,
    pub invoice: Option<Invoice>,
    pub expiry: Option<String>,
    pub merchant: Participant,
    pub customer: Option<Participant>,
    pub agents: Vec<Participant>,
    pub metadata: HashMap<String, Value>,
}

Payment Request message body (TAIP-14)

Fields

asset: Option<AssetId>

Asset identifier in CAIP-19 format (optional if currency is provided)

currency: Option<String>

ISO 4217 currency code for fiat amount (optional if asset is provided)

amount: String

Amount requested in the specified asset or currency

supported_assets: Option<Vec<String>>

Array of CAIP-19 asset identifiers that can be used to settle a fiat currency amount

invoice: Option<Invoice>

Structured invoice information according to TAIP-16

expiry: Option<String>

ISO 8601 timestamp when the request expires

merchant: Participant

Party information for the merchant (beneficiary)

customer: Option<Participant>

Party information for the customer (originator) (optional)

agents: Vec<Participant>

Array of agents involved in the payment request

metadata: HashMap<String, Value>

Additional metadata for the payment request

Implementations

impl PaymentRequest

pub fn new( amount: String, merchant: Participant, agents: Vec<Participant>, ) -> Self

Creates a new PaymentRequest message body

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

Creates a new PaymentRequest message with asset specification

pub fn with_currency( currency: String, amount: String, merchant: Participant, agents: Vec<Participant>, ) -> Self

Creates a new PaymentRequest message with currency specification

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

Validates the PaymentRequest message body

Trait Implementations

impl Clone for PaymentRequest

fn clone(&self) -> PaymentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connectable for PaymentRequest

fn with_connection(&mut self, connect_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 PaymentRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PaymentRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessageBody for PaymentRequest

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.