command

Authorize Payment

Command to authorize payment for the total of a checked-out cart.

Command
POST/payments/authorize

Overview

AuthorizePayment is sent by the Checkout OrchestratorCheckout OrchestratorServicev1.0.0Runs the checkout saga. Reserves inventory, authorizes payment and creates the order, coordinating the steps that turn a...Publishesreserve-inventory, authorize-payment +1Ownerordering-platformMapRepoView docs to authorize payment for the order total. Authorization places a hold on the customer’s payment method; the funds are captured once the order is created. If a later step fails, the authorization is voided.

Architecture diagram

Schema

Event-driven architecture documentation: Acme Inc

JSON Schema

4 properties

Command to authorize payment for the total of a checked-out cart

cartIdstring<uuid>
required

Identifier of the cart being checked out

customerIdstring<uuid>

Identifier of the customer paying

amountinteger
required

Amount to authorize, in minor units (e.g. cents)

Minimum: 0
currencystring
required

ISO 4217 currency code

Match pattern: ^[A-Z]{3}$
Edit this page