Create And Allocate point

Developing

POST/api/v0/partner/enKashCard/create-allocate-points

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

companyId

string

required

Unique Company Id generated on onboarding

cardAccountId

string

required

Unique Card account id for a card account being made.

transactionCode

object

required

ENUM

ALLOCATION

string

required

transactionType

object

required

Card Transaction Type ENUM

string

required

Credit to enkash card

string

required

Debit from enkash card

type

object

required

ENUM

ALLOCATE_POINT

string

required

Allocate Points to card

UNALLOCATE_POINT

string

required

UnAllocate Points from card

string

required

email. id of user - card holder

mobile

string

required

mobile of user - card holder

title

string

required

Mr/Mrs/Ms

firstName

string

required

Name

gender

string

required

Male/Female

loadAmount

number

required

Amount to be loaded in card from account

uniqueReferenceNumber

string

required

Unique Transaction reference number

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

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer

required

message

string

required

payload

object

required

enKashCardId

string

required

Unique Enkash Card ID

userId

string

required

Unique Enkash User Id

cardAccountId

string

required

Unique Enkash Card Account ID

string

required

Email id of card holder (user)

mobile

string

required

Mobile number of card holder

title

string

required

Mr, Mrs, Ms

firstName

string

required

First Name of card holder

gender

string

required

Gender of card holder

otbBalance

integer

required

Available current card balance

cardStatus

string

required

Denotes if a card is :
L("Locked"), UL("UnLocked"), BL("Blocked"),AP("Activation InProgress");

companyId

string

required

Unique Enkash Company Id

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

Last modified: 6 days ago