Skip to content

Payment Domain

Manage authorization capture refund and settlement.


At a Glance

Count
Business Objects 4
Capabilities 1
Processes 15
Events 14
APIs 5
Validation Rules 14

Object Relationships

erDiagram
    PAYMENT_TRANSACTION }o--|| PAYMENT : "belongs-to"
    PAYMENT_TRANSACTION ||..o{ REFUND : "creates"
    PAYMENT ||--o{ PAYMENT_TRANSACTION : "contains"
    PAYMENT ||..|| REFUND : "results-in"
    PAYMENT }o..o{ GIFT_CARD : "uses"
    REFUND }o--|| PAYMENT : "derives-from"

Business Objects

Object Classification Description
Gift Card gift-card aggregate-root Stored-value instrument usable as part of payment.
Payment payment aggregate-root Payment obligation and state associated with a basket, order, return, or exchange.
Payment Transaction payment-transaction entity Transaction-level record for payment authorization, capture, void, refund, or settlement a…
Refund refund aggregate-root Payment reversal or credit associated with a return, exchange, or payment correction.

Capabilities

Capability Archetype Outcome
Payment Processing payment-processing operational Payments can be authorised, captured, voided and refunded independently of payme…

Events

Transitioned (11):
PaymentAuthorized PaymentCaptured PaymentVoided PaymentRefunded PaymentSettled GiftCardActivated GiftCardExpired GiftCardCancelled GiftCardRefunded RefundFailed RefundConvertedToCredit

Updated (3):
GiftCardRedeemed GiftCardToppedUp RefundProcessed

Processes

  • Checkout checkoutA confirmed order is created with payment authorised, promotions applied and loy
  • BOPIS bopisA customer can place an order online and collect it from a physical store on the
  • Endless Aisle endless-aisleA store associate can sell items not physically present in-store and fulfil them
  • Clienteling Sale clienteling-saleA store associate can complete a personalised assisted sale using customer histo
  • Voucher Redemption voucher-redemptionA customer can redeem a gift voucher or store credit as full or partial payment
  • Ship From Store ship-from-storeStore stock can be used to pick, pack and ship online orders directly to the cus
  • BORIS borisA customer can return an online order at any physical store and receive a refund
  • Return Anywhere return-anywhereCustomers can return items to any store or channel regardless of the original pu
  • Exchange Anywhere exchange-anywhereCustomers can exchange items at any store regardless of the original purchase ch
  • Self-Checkout self-checkoutA customer can scan, bag, and pay for items independently at a self-service term
  • Scan and Go scan-and-goCustomer completes payment on their device or at an exit terminal without queuin
  • Subscription Renewal subscription-renewalA subscription is renewed automatically, a new order is generated, payment is ca
  • Decision Review and Execution decision-review-and-executionA material automated decision is approved, overridden, expired, or executed by t
  • Loss Prevention Case Handling loss-prevention-case-handlingAn item or transaction anomaly is triaged and resolved with policy-controlled in
  • Service and Repair Management service-and-repair-managementA service or repair commitment associated with a customer order is created, sche

APIs

Endpoint Method Service Capability
/payments/authorizations POST authorize-payment payment-processing
/payments/authorizations/{id}/capture POST capture-payment payment-processing
/payments/authorizations/{id}/void POST void-payment payment-processing
/payments/{id}/refunds POST refund-payment payment-processing
/transactions/{id}/payment POST authorize-payment payment-processing

Applications

  • POS pos (system of engagement)
  • Payment Hub payment-hub (platform)

Validation Rules

Rule Type Applies To Severity
checkout-requires-active-basket pre-condition checkout invariant
checkout-requires-active-product pre-condition checkout invariant
bopis-requires-store-inventory pre-condition bopis invariant
bopis-requires-channel pre-condition bopis invariant
ship-from-store-requires-routed-order pre-condition ship-from-store invariant
boris-requires-order-with-items pre-condition boris invariant
return-anywhere-requires-return-window pre-condition return-anywhere constraint
exchange-anywhere-requires-closed-order pre-condition exchange-anywhere invariant
voucher-redemption-requires-valid-voucher pre-condition voucher-redemption invariant
endless-aisle-requires-active-channel pre-condition endless-aisle invariant
self-checkout-requires-active-terminal pre-condition self-checkout invariant
loss-prevention-intervention-requires-policy pre-condition loss-prevention-case-handling invariant
checkout-creates-order post-condition checkout invariant
checkout-clears-basket post-condition checkout invariant

Semantic Constraints

Constraint Type Rule
payment-belongs-to-order association A Payment must be associated with exactly one Order. Payment without a…
refund-belongs-to-payment association A Refund must be applied against exactly one original Payment.
payment-owned-by-payment-hub ownership The Payment lifecycle is exclusively owned by the Payment Hub.
payment-in-payment-domain domain-containment The Payment Business Object is owned by the Payment domain.
payment-capture-requires-authorisation lifecycle-gate A payment cannot be captured without prior authorisation. Capture dire…
payment-refund-requires-capture lifecycle-gate A payment cannot be refunded unless it has been captured. Refunding an…
payment-cannot-reactivate-voided lifecycle-gate A voided payment cannot be captured. A new payment authorisation must …

← Back to Domain Catalog