Incentive Create And Allocate point

This API facilitates the creation and management of reward account for employees, allowing for the allocation and reallocation of points. Here’s how you can use it:

Create Reward Card and Allocate Points:

Use this functionality to create a new user (employee) and allocate funds (points) to their reward card.
Ensure to include necessary details such as employee information and initial points allocation.

Allocate/Credit Points:

To add points to an existing reward card, set:
transactionType as CR (Credit)
type as ALLOCATE_POINT
Provide the required details including the amount of points to be allocated.

Unallocate/Debit Points:

To remove points from a reward card, set:
transactionType as DR (Debit)
type as UNALLOCATE_POINT
Specify the details including the amount of points to be debited.

Reference Numbers:

The UniqueReferenceNumber provided in your request should match the pgReferenceNumber received in the response. This ensures transaction integrity and tracking.

Request

Header Params

partnerId

string

required

Example:

CRMXWB3ZM

Content-Type

string

required

Example:

application/json

authorization

string

required

Example:

Bearer {{access_token}}

Body Params application/json

companyId

string

required

cardAccountId

string

required

transactionCode

string

required

transactionType

string

required

type

string

required

string

required

mobile

string

required

title

string

required

firstName

string

required

gender

string

required

loadAmount

number

required

uniqueReferenceNumber

string

required

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"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

code

integer

required

message

string

required

payload

object

required

enKashCardId

string

required

userId

string

required

cardAccountId

string

required

string

required

mobile

string

required

title

string

required

firstName

string

required

gender

string

required

otbBalance

integer

required

cardStatus

string

required

companyId

string

required

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
  }
}

Incentive Create And Allocate point

Create Reward Card and Allocate Points:#

Allocate/Credit Points:#

Unallocate/Debit Points:#

Reference Numbers:#

Request

Request samples

Responses

Create Reward Card and Allocate Points:

Allocate/Credit Points:

Unallocate/Debit Points:

Reference Numbers: