EventCatalog

Properties

id* :

Unique identifier of the payment

userId* :

Users ID

name* :

Users name

email* :

Users email address

phoneNumber* :

Users phone number

clientReferenceId* :

Fixed value "RETAIL_PURCHASE"

amount* :

NET amount collected for the payment

vat* :

VAT amount collected for the payment

paidAmount* :

Total amount (gross) collected for the payment

discount* :

Discount applied for the payment.

coupon* :

Coupon used for the payment.****

country* :

Country code

paymentMethod* :

Method used to make the payment

currency* :

Currency used in the payment. Value can be one of below.

- BHD
- SAR
- AED
- KWD
- QAR
- OMR

items* :

A list of items that is part of the purchase

metadata* :

Set of key-value pairs that can be set by initiator service/user. This can be useful for storing additional information about the object in a structured format.

flowchart LR l-Retail_Service[Retail Service]:::producer-->RetailPaymentSuccessful[RetailPaymentSuccessful]:::event classDef event stroke:#5d56f2,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; RetailPaymentSuccessful[RetailPaymentSuccessful]:::event-->r-API_Service[API Service]:::consumer click l-Retail_Service href "/services/Retail Service" "Go to Retail Service" _self click r-API_Service href "/services/API Service" "Go to API Service" _self click RetailPaymentSuccessful href "/events/RetailPaymentSuccessful" "Go to RetailPaymentSuccessful" _self

RetailPaymentSuccessful Schema (yml)

openapi: 3.0.0
info:
  version: "1.0.0"
  title: RetailPaymentSuccessful
paths: {}
components:
  schemas:
    RetailPaymentSuccessful:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - id
        - userId
        - name
        - email
        - phoneNumber
        - clientReferenceId
        - amount
        - vat
        - discount
        - paidAmount
        - currency
        - country
        - paymentMethod
      properties:
        id:
          type: string
        userId:
          type: string
        name:
          type: string
        email:
          type: string
        phoneNumber:
          type: string
        clientReferenceId:
          type: string
        amount:
          type: number
          format: double
        vat:
          type: number
          format: double
        discount:
          type: number
          format: double
        paidAmount:
          type: number
          format: double
        coupon:
          type: string
        paymentMethod:
          type: string
        currency:
          type: string
        country:
          type: string
    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string

RetailPaymentSuccessfulv1.0.0