OrderWorkflow Steps
Payment Workflow Steps
Workflow steps for payment processing, authorization, capture, refunds, and financial operations in Omnium OMS.
Payment workflow steps handle all financial operations in the order lifecycle, including payment authorization, capture, cancellation, refunds, and integration with payment providers.
Overview
These steps manage:
- Payment capture - Collecting funds when orders ship
- Authorization management - Setting and clearing authorization expiration
- Refunds and credits - Handling cancellations and returns
- Gift cards - Creating and reserving gift cards
- Coupons - Validating and redeeming discount coupons
- Invoicing - Creating invoices for orders
Available Steps
Core Payment Operations
| Step | Key | Description |
|---|---|---|
| Capture Payments | CapturePayments | Capture payment for shipped orders |
| Cancel Payments | CancelPayments | Cancel or void active payments |
| Authorize Payment | AuthorizePayment | Authorize payment with provider |
| Credit Cancelled Order Lines | CreditCancelledOrderLines | Refund captured amounts for cancelled lines |
| Create Payment Remaining | CreatePaymentRemaining | Create payment for remaining amount |
| Try Release Remaining Auth | TryReleaseRemainingAuth | Release unused authorization amounts |
Authorization Management
| Step | Key | Description |
|---|---|---|
| Set Authorization Expires | SetAuthorizationExpires | Calculate and set payment expiration dates |
| Remove Authorization Expires | RemoveAuthorizationExpires | Clear expiration after capture |
Payment Validation & Enrichment
| Step | Key | Description |
|---|---|---|
| Verify Order Payment Method | VerifyOrderPaymentMethod | Validate payment method is allowed |
| Add Payment Type Tag | AddPaymentTypeTagToOrder | Tag order with payment method name |
| Add Payment Merchant ID | AddPaymentMerchantIdToOrder | Add merchant ID to payment properties |
| Add Shipment Info to Payment Provider | AddShipmentInfoToPaymentProvider | Send tracking info to payment provider |
Coupons & Discounts
| Step | Key | Description |
|---|---|---|
| Check Personal Discount Coupons | CheckPersonalDiscountCoupons | Validate personal discount coupons |
| Try Redeem Personal Discount Coupons | TryRedeemPersonalDiscountCoupons | Redeem validated coupons |
| Check and Update Coupon Usage | CheckAndUpdateCouponUsage | Update coupon usage with provider |
Gift Cards
| Step | Key | Description |
|---|---|---|
| Create and Send Gift Cards | CreateAndSendGiftCards | Create and deliver purchased gift cards |
| Reserve Gift Cards | ReserveGiftCards | Reserve gift cards for order |
Invoicing
| Step | Key | Description |
|---|---|---|
| Create Invoice | CreateInvoice | Generate invoice for order/shipment |
Replacement Orders
| Step | Key | Description |
|---|---|---|
| Transfer Replacement Order Payment | TransferReplacementOrderPayment | Transfer payment from original to replacement order |
Payment Flow
A typical payment flow through workflow steps:
- New Order:
SetAuthorizationExpires→VerifyOrderPaymentMethod→CheckPersonalDiscountCoupons - Ship/Complete:
CapturePayments→RemoveAuthorizationExpires→TryReleaseRemainingAuth→AddShipmentInfoToPaymentProvider - Cancel:
CancelPaymentsorCreditCancelledOrderLines
Multi-Payment Support
Omnium supports multiple payments per order with:
- Capture Priority - Control which payment is captured first
- Credit Priority - Control which payment is credited first
- Partial capture across multiple payment methods
Common Configuration
Many payment steps use tenant-level payment configuration from TenantSettings.PaymentConfiguration:
AllowCompleteOrderWithoutPayment- Allow orders with no paymentPaymentTypes- Configured payment methods and their settings