Struct ReceiptAccess 

pub struct ReceiptAccess {
    pub version: u8,
    pub kind: PrivateMessageKind,
    pub event_id: EventId,
    pub receipt_id: ReceiptId,
    pub payment_reference: PaymentReference,
    pub payment_request_id: Option<PaymentRequestId>,
    pub billing_period: Option<BillingPeriod>,
    pub location: String,
    pub key: ReceiptDecryptionKey,
}

Receipt Access descriptor sent over the existing Noise channel.

Fields

version: u8

Receipt Access message version. Currently always 1.

kind: PrivateMessageKind

Private message kind. Currently always PrivateMessageKind::ReceiptAccess.

event_id: EventId

Event ID for idempotent processing.

receipt_id: ReceiptId

Receipt artifact identifier used to derive the Receipt Location path.

payment_reference: PaymentReference

Payment Reference for the receipt.

payment_request_id: Option<PaymentRequestId>

Optional Payment Request ID this Receipt Access corresponds to.

billing_period: Option<BillingPeriod>

Optional Billing Period for recurring Payment Request receipts.

location: String

Homeserver path of the Encrypted Receipt.

key: ReceiptDecryptionKey

Symmetric key needed to decrypt the Receipt.

Implementations

impl ReceiptAccess

pub fn location_for(receipt_id: &ReceiptId) -> String

Return the canonical Receipt Location path for a Receipt ID.

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

Validate that this access descriptor points at the canonical location for its Receipt ID.

This public validator is for caller-supplied values and returns PaykitError::Validation on mismatch. Wire parsing maps the same mismatch to PaykitError::InvalidData because incoming private message payloads are external data.

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

Validate caller-supplied Receipt Access before sending or storing.

Trait Implementations

impl Clone for ReceiptAccess

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptAccess

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

Formats the value using the given formatter.

impl Eq for ReceiptAccess

impl PartialEq for ReceiptAccess

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReceiptAccess