Skip to content

Authorize Payment

POST /payments/authorizations command bearer

Submits a payment authorisation request for the order total. Returns a Payment with authorization-code on success.

Overview
ID authorize-payment-api
Method POST
Path /payments/authorizations
Classification command
Domain payment
Capability payment-processing
Service authorize-payment
Application payment-hub — Payment Hub
Auth bearer

Request Body
Business Object order
Description Confirmed commercial commitment created from checkout or assisted selling.
Classification aggregate-root
Lifecycle draft → confirmed → in-fulfilment → partially-fulfilled → completed → return-in-progress → cancelled

Response
Business Object payment
Description Payment obligation and state associated with a basket, order, return, or exchange.
Lifecycle pending → authorised → captured → partially-refunded → fully-refunded → voided → failed

Events Emitted

Event Classification Object Description
payment-authorized transitioned payment The payment was pre-authorised with the payment provider for the required amount.

Integration Patterns

Pattern Flow Style Description
POS → Payment Hub pos → payment-hub synchronous-api The POS calls the Payment Hub for every payment tender during checkout — card authorisation, gift card validation, and BNPL initiation.

Scenarios using payment-processing

Scenario Description
Buy Online, Pick Up In Store Customer browses and purchases online, then collects the order from a physical store. The canonical
Buy Online, Return In Store Customer purchased online (any channel) and returns the item at a physical store. The store processe
Unified Omnichannel Checkout Customer completes a standard commerce checkout journey from basket through pricing, promotions, pay
Clienteling Sale A store associate uses a clienteling application to identify a known customer, review their purchase
Endless Aisle Store associate helps a customer order an item that is not physically stocked in the current store b
Exchange Anywhere Customer exchanges an item purchased in any channel at any supported touchpoint. The original item i
Loss Prevention Case Handling A checkout or item-identification anomaly is captured as evidence, triaged under an approved interve
Reserve and Collect Customer reserves stock online for in-store collection without paying at the time of reservation. Th
Scan and Go Customer scans items using a mobile app while shopping, receives promotions and loyalty benefits in
Self-Checkout Customer scans and bags items at a self-checkout kiosk, receives applicable promotions, settles paym
Service and Repair Management A customer or associate creates a repair, installation, or maintenance commitment linked to the orig
Ship From Store An online order is fulfilled by shipping the goods directly from a physical store rather than a cent
Ship To Store Customer places an online order for collection at a chosen store while stock is sourced from a wareh
Store Day Open A physical store executes its opening routine before serving customers for the day. The scenario cov
Subscription Renewal A recurring subscription is renewed either automatically or after a customer reminder and confirmati
Unified Return Customer returns an item regardless of the original purchase channel. The return may be initiated on
Voucher Redemption Customer redeems a voucher or gift card during checkout in store or online. The flow covers voucher
API Method Path Type
Capture Payment POST /payments/authorizations/{id}/capture action
Void Payment POST /payments/authorizations/{id}/void action
Refund Payment POST /payments/{id}/refunds command
Add Payment POST /transactions/{id}/payment command