Enkash Developer Portal
Home
Home
Login
  1. Rewards & Incentives
  • Explore Our Product Suite
  • Payment Gateway
    • Set Up Payment Gateway
    • Payment Options
    • Easy API Setup
    • Payment Gateway APIs
  • Payouts
    • Set Up Payouts
    • Payout APIs
  • Prepaid Cards
    • Key Capabilities
    • Set Up Prepaid Cards
    • Prepaid Card APIs
  • Wallet
    • Wallet APIs
    • wallet payment api
  • Bharat Connect (BBPS)
    • Vendor Payment
    • Bill Payment
  • Accounts Payable
    • Accounts Payable APIs
  • Account Receivable
    • Accounts Receivable Overview
    • Account Receivable APIs
  • Expense Management
    • Expense Management Overview
    • About Authorization
    • Expense APIs
  • Rewards & Incentives
    • About Rewards
    • Getting Started
    • Encryption & Decryption Guide
    • Reward Allocation
    • Incentive Allocation
    • Reward APIs
  • Verification Suite
    • Verification Suite Overview
    • Verification Suite APIs
  1. Rewards & Incentives

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#

FieldWhere It's UsedDescription
uniqueReferenceNumberRequestSent by the client to uniquely identify the transaction
pgReferenceNumberResponseReturned by EnKash for transaction confirmation & traceability
These must match to ensure transaction traceability

Endpoint#

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

Request#

Header Parameters
NameTypeRequiredExample
partnerIdstringCRMXWB3ZM
Content-Typestringapplication/json
AuthorizationstringBearer {{access_token}}
Body Parameters
FieldTypeRequiredDescription
companyIdstringUnique EnKash Company ID
cardAccountIdstringReward account ID
transactionCodestringType of transaction (e.g., ALLOCATION)
transactionTypestringCR for credit, DR for debit
typestringALLOCATE_POINT or UNALLOCATE_POINT
emailstringEmployee’s email
mobilestringEmployee’s mobile
titlestringMr/Mrs/Ms
firstNamestringEmployee’s first name
genderstringM/F
loadAmountnumberAmount of points
uniqueReferenceNumberstringUnique 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
FieldTypeDescription
codeinteger0 = success
messagestringAPI status message
payloadobjectContains card and user details
enKashCardIdstringUnique card ID
enkashCardTxnIdstringTransaction ID
otbBalancenumberAvailable balance on the reward card
pgReferenceNumberstringMatches 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
Modified at 2025-05-24 10:50:36
Previous
Reward Allocation
Next
Reward APIs
Built with