Incentive Account Creation & Points Allocation

This API enables you to create a incentive account for your partners and allocate or reallocate points (either credit or debit). It is suitable for use cases like partner onboarding, incentive programs, or points management.

How It Works

Create a new user and allocate initial incentive points

transactionType: CR (Credit)

type: ALLOCATE_POINT

Credit points to an existing incentive account

transactionType: CR

type: ALLOCATE_POINT

Unallocate / Debit Points

transactionType: DR (Debit)

type: UNALLOCATE_POINT

Reference Numbers

Field	Where It's Used	Description
`uniqueReferenceNumber`	Request	Sent by the client to uniquely identify the transaction
`pgReferenceNumber`	Response	Returned by EnKash for transaction confirmation & traceability

These must match to ensure transaction traceability

Endpoint

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

Request

Header Parameters

Name	Type	Example
`partnerId`	string	`CRMXWB3ZM`
`Content-Type`	string	`application/json`
`Authorization`	string	`Bearer {{access_token}}`

Body Parameters

Field	Type	Description
`companyId`	string	Unique EnKash Company ID
`cardAccountId`	string	Reward account ID
`transactionCode`	string	Type of transaction (e.g., `ALLOCATION`)
`transactionType`	string	`CR` for credit, `DR` for debit
`type`	string	`ALLOCATE_POINT` or `UNALLOCATE_POINT`
`email`	string	Employee’s email
`mobile`	string	Employee’s mobile
`title`	string	Mr/Mrs/Ms
`firstName`	string	Employee’s first name
`gender`	string	M/F
`loadAmount`	number	Amount of points
`uniqueReferenceNumber`	string	Unique transaction reference ID

Example Request

{
  "companyId": "CEK1PU9AOO",
  "cardAccountId": "CAQL8YCV3",
  "transactionCode": "ALLOCATION",
  "transactionType": "CR",
  "type": "ALLOCATE_POINT",
  "email": "[email protected]",
  "mobile": "9600098867",
  "title": "Mr",
  "firstName": "hedfdfg",
  "gender": "M",
  "loadAmount": 11,
  "uniqueReferenceNumber": "TEST234236"
}

Response

HTTP Status Code 200 OK

Response Body

Field	Type	Description
`code`	integer	`0` = success
`message`	string	API status message
`payload`	object	Contains card and user details
`enKashCardId`	string	Unique card ID
`enkashCardTxnId`	string	Transaction ID
`otbBalance`	number	Available balance on the reward card
`pgReferenceNumber`	string	Matches your `uniqueReferenceNumber`

Example Response

{
  "code": 0,
  "message": "Success",
  "payload": {
    "enKashCardId": "EKC04AZHXP",
    "enkashCardTxnId": "ECTRSZJ8CRJ2E",
    "cardAccountId": "CAQL8YCV3",
    "email": "[email protected]",
    "mobile": "9600098867",
    "title": "Mr",
    "firstName": "hedfdfg",
    "gender": "M",
    "otbBalance": 11,
    "companyId": "CEK1PU9AOO",
    "cardStatus": {
      "name": "UL",
      "label": "UnLocked"
    },
    "kycStatus": {
      "name": "VERIFIED",
      "label": "Verified"
    },
    "binType": {
      "name": "REWARD",
      "label": "Reward Card"
    },
    "cardActivated": true,
    "virtualAccountNumber": "ENKASHEDENKEKC04AZHXP",
    "rewardPointsReceived": 11
  }
}

Ensure employee’s card is active and KYC verified

For debit operations (UNALLOCATE_POINT), ensure sufficient balance exists

Use matching reference numbers for consistent reconciliation

Incentive Account Creation & Points Allocation

How It Works#

Create a new user and allocate initial incentive points#

Credit points to an existing incentive account#

Unallocate / Debit Points#

Reference Numbers#

Endpoint#

Request#

Response#

How It Works

Create a new user and allocate initial incentive points

Credit points to an existing incentive account

Unallocate / Debit Points

Reference Numbers

Endpoint

Request

Response