Skip to main content

Payment

Struct Payment 

Source
pub struct Payment {
Show 37 fields pub id: PaymentId, pub payment_number: String, pub order_id: Option<OrderId>, pub invoice_id: Option<Uuid>, pub customer_id: Option<CustomerId>, pub status: PaymentTransactionStatus, pub payment_method: PaymentMethodType, pub amount: Decimal, pub currency: CurrencyCode, pub amount_refunded: Decimal, pub external_id: Option<String>, pub idempotency_key: Option<String>, pub processor: Option<String>, pub card_brand: Option<CardBrand>, pub card_last4: Option<String>, pub card_exp_month: Option<i32>, pub card_exp_year: Option<i32>, pub blockchain_network: Option<BlockchainNetwork>, pub stablecoin_type: Option<StablecoinType>, pub from_wallet_address: Option<String>, pub to_wallet_address: Option<String>, pub tx_hash: Option<String>, pub block_number: Option<i64>, pub confirmations: Option<i32>, pub token_address: Option<String>, pub ves_intent_id: Option<String>, pub billing_email: Option<String>, pub billing_name: Option<String>, pub billing_address: Option<String>, pub description: Option<String>, pub failure_reason: Option<String>, pub failure_code: Option<String>, pub metadata: Option<String>, pub paid_at: Option<DateTime<Utc>>, pub version: i32, pub created_at: DateTime<Utc>, pub updated_at: DateTime<Utc>,
}
Expand description

A payment transaction

Fields§

§id: PaymentId

Unique payment ID

§payment_number: String

Human-readable payment number

§order_id: Option<OrderId>

Associated order ID (optional - can be standalone payment)

§invoice_id: Option<Uuid>

Associated invoice ID (optional)

§customer_id: Option<CustomerId>

Customer ID

§status: PaymentTransactionStatus

Payment status

§payment_method: PaymentMethodType

Payment method used

§amount: Decimal

Payment amount

§currency: CurrencyCode

Currency code (ISO 4217)

§amount_refunded: Decimal

Amount refunded

§external_id: Option<String>

External payment processor ID (e.g., Stripe payment intent ID)

§idempotency_key: Option<String>

Idempotency key for safely retrying payment creation

§processor: Option<String>

Payment processor/gateway used

§card_brand: Option<CardBrand>

Card brand (if card payment)

§card_last4: Option<String>

Last 4 digits of card (if card payment)

§card_exp_month: Option<i32>

Card expiry month (if card payment)

§card_exp_year: Option<i32>

Card expiry year (if card payment)

§blockchain_network: Option<BlockchainNetwork>

Blockchain network (for crypto/stablecoin payments)

§stablecoin_type: Option<StablecoinType>

Stablecoin type (USDC, USDT, ssUSD, etc.)

§from_wallet_address: Option<String>

Sender wallet address

§to_wallet_address: Option<String>

Recipient wallet address

§tx_hash: Option<String>

On-chain transaction hash/signature

§block_number: Option<i64>

Block number where transaction was confirmed

§confirmations: Option<i32>

Number of on-chain confirmations

§token_address: Option<String>

Token contract/mint address (for token transfers)

§ves_intent_id: Option<String>

VES payment intent ID (for audit trail)

§billing_email: Option<String>

Billing email

§billing_name: Option<String>

Billing name

§billing_address: Option<String>

Billing address

§description: Option<String>

Payment description

§failure_reason: Option<String>

Failure reason (if failed)

§failure_code: Option<String>

Failure code from processor

§metadata: Option<String>

Metadata (JSON)

§paid_at: Option<DateTime<Utc>>

When payment was completed

§version: i32

Version for optimistic locking

§created_at: DateTime<Utc>

When payment was created

§updated_at: DateTime<Utc>

When payment was last updated

Implementations§

Source§

impl Payment

Source

pub fn refundable_remaining(&self) -> Decimal

The amount of this payment that has not yet been refunded.

Source

pub fn validate_refund( &self, requested: Option<Decimal>, ) -> Result<Decimal, CommerceError>

Validate and resolve a refund request against this payment.

requested is the caller-supplied refund amount; when None the full remaining refundable balance is used. Returns the resolved refund amount on success.

§Errors

Returns crate::CommerceError::ValidationError when:

  • the payment is not in a refundable status (only Completed / PartiallyRefunded payments can be refunded),
  • the requested (or resolved) amount is zero or negative, or
  • the requested amount exceeds the remaining refundable balance.

Trait Implementations§

Source§

impl Clone for Payment

Source§

fn clone(&self) -> Payment

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Payment

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Payment, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Payment

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more