# Incentive Create And Allocation

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/partner/enKashCard/create-allocate-points:
    post:
      summary: Incentive Create And Allocation
      deprecated: false
      description: >-

        :::highlight orange 📌

        This API enables partners to create incentive entries and allocate
        corresponding reward points to users (customers or partners). It
        supports both initial reward creation and incremental allocations,
        making it ideal for performance bonuses, milestone rewards, or any
        points-based incentive programs

        :::
      tags:
        - Rewards & Incentives/APIs - Reward/Incentive Allocation
      parameters:
        - name: partnerId
          in: header
          description: ''
          required: true
          example: CRMXWB3ZM
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: authorization
          in: header
          description: ''
          required: true
          example: Bearer {{access_token}}
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                companyId:
                  type: string
                cardAccountId:
                  type: string
                transactionCode:
                  type: string
                transactionType:
                  type: string
                type:
                  type: string
                email:
                  type: string
                mobile:
                  type: string
                title:
                  type: string
                firstName:
                  type: string
                gender:
                  type: string
                loadAmount:
                  type: number
                uniqueReferenceNumber:
                  type: string
              required:
                - companyId
                - cardAccountId
                - transactionCode
                - transactionType
                - type
                - email
                - mobile
                - title
                - firstName
                - gender
                - loadAmount
                - uniqueReferenceNumber
              x-apidog-orders:
                - companyId
                - cardAccountId
                - transactionCode
                - transactionType
                - type
                - email
                - mobile
                - title
                - firstName
                - gender
                - loadAmount
                - uniqueReferenceNumber
            example:
              companyId: CEK1PU9AOO
              cardAccountId: CAQL8YCV3
              transactionCode: ALLOCATION
              transactionType: CR
              type: ALLOCATE_POINT
              email: xyz2@gmail.com
              mobile: '9600098867'
              title: Mr
              firstName: hedfdfg
              gender: M
              loadAmount: 11
              uniqueReferenceNum: TEST234236
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  payload:
                    type: object
                    properties:
                      enKashCardId:
                        type: string
                      userId:
                        type: string
                      cardAccountId:
                        type: string
                      email:
                        type: string
                      mobile:
                        type: string
                      title:
                        type: string
                      firstName:
                        type: string
                      gender:
                        type: string
                      otbBalance:
                        type: integer
                      cardStatus:
                        type: string
                      companyId:
                        type: string
                    required:
                      - enKashCardId
                      - userId
                      - cardAccountId
                      - email
                      - mobile
                      - title
                      - firstName
                      - gender
                      - otbBalance
                      - cardStatus
                      - companyId
                    x-apidog-orders:
                      - enKashCardId
                      - userId
                      - cardAccountId
                      - email
                      - mobile
                      - title
                      - firstName
                      - gender
                      - otbBalance
                      - cardStatus
                      - companyId
                required:
                  - code
                  - message
                  - payload
                x-apidog-orders:
                  - code
                  - message
                  - payload
              example:
                code: 0
                message: Success
                payload:
                  enKashCardId: EKC04AZHXP
                  userId: EKIQB4L2
                  cardAccountId: CAQL8YCV3
                  token: 16b9c31b42643796e064
                  maskedNumber: XXXX XXXX XXXX 8867
                  expiryMonth: '06'
                  expiryYear: '2026'
                  email: xyz2@gmail.com
                  mobile: '9600098867'
                  title: Mr
                  firstName: hedfdfg
                  gender: M
                  usedMtd: 0
                  usedDtd: 0
                  usedYtd: 0
                  otbBalance: 11
                  primaryCard: false
                  prepaidCard: true
                  physicalCard: false
                  deleted: false
                  closedLoopCard: false
                  createdOn: Jun 20, 2024 2:56:47 PM
                  modifiedOn: Jun 20, 2024 2:56:47 PM
                  cardStatus:
                    name: UL
                    label: UnLocked
                  kycStatus:
                    name: VERIFIED
                    label: Verified
                  cardProgramme: SBM
                  useAccountFunds: false
                  blockCode: A
                  partnerLogo: https://image.enkash.in/IMAGES/sbm-logo.png
                  physicalDeliveryAddressFlag: false
                  cardActivated: true
                  binType:
                    name: REWARD
                    label: Reward Card
                  loadAmount: 11
                  companyId: CEK1PU9AOO
                  cardKitMasterId: 14
                  extEntityId: EXT3YTK2P7CYK
                  switchProvider: EK_CLOSEDLOOP_CREDIT
                  accountBalance: 38628
                  physicalCardAllowed: false
                  surchargeAmt: 0
                  panValidated: false
                  usedLtd: 0
                  latestTnCVersionAccepted: true
                  latestKeyFactAccepted: true
                  latestTnCVersionAcceptedForPrimaryCard: true
                  latestKeyFactAcceptedCardForPrimaryCard: true
                  virtualAccountNumber: ENKASHEDENKEKC04AZHXP
                  limitAllocatedLtd: 0
                  posAllowed: false
                  posAllowedAdmin: false
                  atmAllowed: false
                  atmAllowedAdmin: false
                  onlineAllowed: false
                  onlineAllowedAdmin: false
                  liveImage: false
                  cKycEnabled: false
                  unallocateFundAllowed: true
                  useParentFundAllowed: false
                  minKycOtpVerified: false
                  enKashSupportEmail: support@enkash.in
                  enKashSupportMobile: '1234567890'
                  companyName: Test Company
                  vKycAllowed: false
                  accountType:
                    name: EMPLOYEE_REWARDS
                    label: Employee Rewards
                    description: Reward
                  lastAllocatedAmount: 0
                  holdBalance: 0
                  enkashCardTxnId: ECTRSZJ8CRJ2E
                  unAllocateHoldBalance: 0
                  tncUnAllocateAllowed: false
                  tncUnAllocateAccepted: false
                  totalRewardsReceived: 1
                  rewardPointsReceived: 11
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Rewards & Incentives/APIs - Reward/Incentive Allocation
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-9796911-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```