logoEventCatalog

AddLoyaltyPoints
v1.0.0

Command event to add loyalty points to a user.

Properties:

userId* :

ID of the user to add the loyalty points to.

referenceId* :

The unique ID of the reference that is related to the points being added. This can be a transaction ID that is related to a payment etc.

amount* :

The NET amount that has been paid in the users currency. This amount should include the amount with the discount applied if there is any, and excluding the VAT.

currency* :

Currency used in the transaction. Value can be one of below.
- BHD
- SAR
- AED
- KWD
- QAR
- OMR

actor* :

The person who created this command
AddLoyaltyPoints Schema (yml)
openapi: 3.0.0
info:
  version: "1.0.0"
  title: AddLoyaltyPoints
paths: {}
components:
  schemas:
    AddLoyaltyPoints:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - userId
        - referenceId
        - amount
        - currency
        - actor

      properties:
        userId:
          type: string
        amount:
          type: number
        referenceId:
          type: string
        currency:
          type: string
        actor:
          type: string

    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string
Edit this pageLast updated on 2024/4/2