Finance Service API 1.0.0

Orchestrates order processing and financial transactions for BookWorm

Servers

  • amqp://dev.eventbus:5672/amqp 0.9.1development

    RabbitMQ server for development environment

    Security:
    • User/Password

      An authentication method for the server

    • #env:development
  • amqp://stg.eventbus:5672/amqp 0.9.1staging

    RabbitMQ server for staging environment

    Security:
    • User/Password

      An authentication method for the server

    • #env:staging
  • amqp://qa.eventbus:5672/amqp 0.9.1qa

    RabbitMQ server for QA environment

    Security:
    • User/Password

      An authentication method for the server

    • #env:qa
  • amqp://prod.eventbus:5672/amqp 0.9.1production

    RabbitMQ server for production environment

    Security:
    • User/Password

      An authentication method for the server

    • #env:production

Operations

  • SEND notification-cancel-order

    Event emitted when a user cancels an order

    Cancel order notification

    Represents a successful integration event when cancelling an order in the system

    Operation IDCancelOrderCommand

    Available only on servers:

    Accepts the following message:

    Message IDCancelOrderCommand.message
    allOf

    Event published when a user cancels an order, containing details about the order

    Examples

  • SEND notification-complete-order

    Event emitted when a user completes an order

    Complete order notification

    Represents a successful integration event when completing an order in the system

    Operation IDCompleteOrderCommand

    Available only on servers:

    Accepts the following message:

    Message IDCompleteOrderCommand.message
    allOf

    Event published when a user completes an order, containing details about the order

    Examples

  • SEND basket-checkout-complete

    Event emitted when a user completes a basket checkout

    Delete basket complete

    Represents a successful integration event when deleting a basket in the system

    Operation IDDeleteBasketCompleteCommand

    Available only on servers:

    Accepts the following message:

    Message IDDeleteBasketCompleteCommand.message
    allOf

    Event published when a basket is deleted and the order is complete, containing details about the order

    Examples

  • SEND basket-checkout-failed

    Event emitted when a user fails to complete a basket checkout

    Delete basket failed

    Represents a failed integration event when deleting a basket in the system

    Operation IDDeleteBasketFailedCommand

    Available only on servers:

    Accepts the following message:

    Message IDDeleteBasketFailedCommand.message
    allOf

    Event published when a basket is deleted and the order fails, containing details about the order

    Examples

  • SEND basket-place-order

    Event emitted when a user places an order

    Place order notification

    Represents a successful integration event when placing an order in the system

    Operation IDPlaceOrderCommand

    Available only on servers:

    Accepts the following message:

    Message IDPlaceOrderCommand.message
    allOf

    Event published when a user places an order, containing details about the order

    Examples

  • RECEIVE BookWorm.Contracts:BasketDeletedCompleteIntegrationEvent

    Event emitted when a basket is deleted and the order is complete

    Basket deleted complete

    Represents a successful integration event when deleting a basket in the system

    Operation IDBasketDeletedCompleteIntegrationEvent

    Available only on servers:

    Accepts the following message:

    Message IDBasketDeletedCompleteIntegrationEvent.message
    allOf

    Event consumed when a basket is deleted and the order is complete, containing details about the order

    Examples

  • RECEIVE BookWorm.Contracts:BasketDeletedFailedIntegrationEvent

    Event emitted when a basket is deleted and the order fails

    Basket deleted failed

    Represents a failed integration event when deleting a basket in the system

    Operation IDBasketDeletedFailedIntegrationEvent

    Available only on servers:

    Accepts the following message:

    Message IDBasketDeletedFailedIntegrationEvent.message
    allOf

    Event consumed when a basket is deleted and the order fails, containing details about the order

    Examples

  • RECEIVE BookWorm.Contracts:OrderStatusChangedToCompleteIntegrationEvent

    Event emitted when the order status is changed to complete

    Order status changed to cancel

    Represents a successful integration event when the order status is changed to cancel in the system

    Operation IDOrderStatusChangedToCancelIntegrationEvent

    Available only on servers:

    Accepts the following message:

    Message IDOrderStatusChangedToCompleteIntegrationEvent.message
    allOf

    Event consumed when the order status is changed to complete, containing details about the order

    Examples

  • RECEIVE BookWorm.Contracts:UserCheckedOutIntegrationEvent

    Event emitted when a user checks out

    User checked out

    Represents a successful integration event when a user checks out in the system

    Operation IDUserCheckedOutIntegrationEvent

    Available only on servers:

    Accepts the following message:

    Message IDUserCheckedOutIntegrationEvent.message
    allOf

    Event consumed when a user checks out, containing details about the order

    Examples

Messages

  • #1
    Message IDCancelOrderCommand
    allOf

    Event published when a user cancels an order, containing details about the order

  • #2
    Message IDCompleteOrderCommand
    allOf

    Event published when a user completes an order, containing details about the order

  • #3
    Message IDDeleteBasketCompleteCommand
    allOf

    Event published when a basket is deleted and the order is complete, containing details about the order

  • #4
    Message IDDeleteBasketFailedCommand
    allOf

    Event published when a basket is deleted and the order fails, containing details about the order

  • #5
    Message IDPlaceOrderCommand
    allOf

    Event published when a user places an order, containing details about the order

  • #6
    Message IDBasketDeletedCompleteIntegrationEvent
    allOf

    Event consumed when a basket is deleted and the order is complete, containing details about the order

  • #7
    Message IDBasketDeletedFailedIntegrationEvent
    allOf

    Event consumed when a basket is deleted and the order fails, containing details about the order

  • #8
    Message IDOrderStatusChangedToCancelIntegrationEvent
    allOf

    Event consumed when the order status is changed to cancel, containing details about the order

  • #9
    Message IDOrderStatusChangedToCompleteIntegrationEvent
    allOf

    Event consumed when the order status is changed to complete, containing details about the order

  • #10
    Message IDUserCheckedOutIntegrationEvent
    allOf

    Event consumed when a user checks out, containing details about the order

Schemas

  • object

    Base event structure containing common metadata for all integration events in the system

  • allOf

    Event published when a user cancels an order, containing details about the order

  • allOf

    Event published when a user completes an order, containing details about the order

  • allOf

    Event published when a basket is deleted and the order is complete, containing details about the order

  • allOf

    Event published when a basket is deleted and the order fails, containing details about the order

  • allOf

    Event published when a user places an order, containing details about the order

  • allOf

    Event consumed when a basket is deleted and the order is complete, containing details about the order

  • allOf

    Event consumed when a basket is deleted and the order fails, containing details about the order

  • allOf

    Event consumed when the order status is changed to cancel, containing details about the order

  • allOf

    Event consumed when the order status is changed to complete, containing details about the order

  • allOf

    Event consumed when a user checks out, containing details about the order