Struct Payments 

pub struct Payments { /* private fields */ }

Payment operations for transaction processing and refunds

Implementations

impl Payments

pub fn create(&self, input: CreatePayment) -> Result<Payment>

Create a new payment

Example

use stateset_embedded::{Commerce, CreatePayment, PaymentMethodType, CardBrand, OrderId, CurrencyCode};
use rust_decimal_macros::dec;

let commerce = Commerce::new("./store.db")?;

let payment = commerce.payments().create(CreatePayment {
    order_id: Some(OrderId::new()),
    payment_method: PaymentMethodType::CreditCard,
    amount: dec!(149.99),
    currency: Some(CurrencyCode::USD),
    card_brand: Some(CardBrand::Visa),
    card_last4: Some("4242".into()),
    billing_email: Some("customer@example.com".into()),
    ..Default::default()
})?;

pub fn get(&self, id: PaymentId) -> Result<Option<Payment>>

Get a payment by ID

pub fn get_by_number(&self, payment_number: &str) -> Result<Option<Payment>>

Get a payment by payment number (e.g., “PAY-20231215123456”)

pub fn get_by_external_id(&self, external_id: &str) -> Result<Option<Payment>>

Get a payment by external ID (e.g., Stripe payment intent ID)

pub fn update(&self, id: PaymentId, input: UpdatePayment) -> Result<Payment>

Update a payment

pub fn list(&self, filter: PaymentFilter) -> Result<Vec<Payment>>

List payments with optional filtering

pub fn for_order(&self, order_id: OrderId) -> Result<Vec<Payment>>

Get all payments for an order

pub fn for_invoice(&self, invoice_id: Uuid) -> Result<Vec<Payment>>

Get all payments for an invoice

pub fn mark_processing(&self, id: PaymentId) -> Result<Payment>

Mark payment as processing

pub fn mark_completed(&self, id: PaymentId) -> Result<Payment>

Mark payment as completed

This records the payment timestamp and marks the transaction as successful.

pub fn mark_failed( &self, id: PaymentId, reason: &str, code: Option<&str>, ) -> Result<Payment>

Mark payment as failed

Arguments

• id - Payment ID
• reason - Human-readable failure reason
• code - Optional error code from payment processor

pub fn cancel(&self, id: PaymentId) -> Result<Payment>

Cancel a payment

pub fn create_refund(&self, input: CreateRefund) -> Result<Refund>

Create a refund for a payment

Example

use stateset_embedded::{Commerce, CreateRefund, PaymentId};
use rust_decimal_macros::dec;

let commerce = Commerce::new("./store.db")?;

// Full refund (omit amount for full refund)
let refund = commerce.payments().create_refund(CreateRefund {
    payment_id: PaymentId::new(),
    reason: Some("Customer request".into()),
    ..Default::default()
})?;

// Partial refund
let refund = commerce.payments().create_refund(CreateRefund {
    payment_id: PaymentId::new(),
    amount: Some(dec!(50.00)),
    reason: Some("Partial refund for damaged item".into()),
    ..Default::default()
})?;

pub fn get_refund(&self, id: Uuid) -> Result<Option<Refund>>

Get a refund by ID

pub fn get_refunds(&self, payment_id: PaymentId) -> Result<Vec<Refund>>

Get all refunds for a payment

pub fn complete_refund(&self, id: Uuid) -> Result<Refund>

Complete a refund

This marks the refund as processed and updates the payment’s refunded amount.

pub fn fail_refund(&self, id: Uuid, reason: &str) -> Result<Refund>

Mark a refund as failed

pub fn create_payment_method( &self, input: CreatePaymentMethod, ) -> Result<PaymentMethod>

Create a stored payment method for a customer

Example

use stateset_embedded::{Commerce, CreatePaymentMethod, PaymentMethodType, CardBrand, CustomerId};

let commerce = Commerce::new("./store.db")?;

let method = commerce.payments().create_payment_method(CreatePaymentMethod {
    customer_id: CustomerId::new(),
    method_type: PaymentMethodType::CreditCard,
    is_default: Some(true),
    card_brand: Some(CardBrand::Visa),
    card_last4: Some("4242".into()),
    card_exp_month: Some(12),
    card_exp_year: Some(2025),
    cardholder_name: Some("Alice Smith".into()),
    ..Default::default()
})?;

pub fn get_payment_methods( &self, customer_id: CustomerId, ) -> Result<Vec<PaymentMethod>>

Get all payment methods for a customer

pub fn delete_payment_method(&self, id: Uuid) -> Result<()>

Delete a payment method

pub fn set_default_payment_method( &self, customer_id: CustomerId, method_id: Uuid, ) -> Result<()>

Set a payment method as the default for a customer

pub fn count(&self, filter: PaymentFilter) -> Result<u64>

Count payments matching a filter

Trait Implementations

impl Debug for Payments

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

Formats the value using the given formatter.